Accounting API
GET
Get account transaction
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId
QUERY PARAMS
companyId
connectionId
accountTransactionId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionIdhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions/:accountTransactionId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List account transactions
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions
QUERY PARAMS
page
companyId
connectionId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/accountTransactions?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/accountTransactions?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/accountTransactions?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/accountTransactions') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page='http GET '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/accountTransactions?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create account
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/accounts HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/accounts',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/accounts", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/accounts') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/accountsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/accounts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get account
{{baseUrl}}/companies/:companyId/data/accounts/:accountId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/accounts/:accountId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/accounts/:accountId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/accounts/:accountId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/accounts/:accountId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/accounts/:accountId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/accounts/:accountId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/accounts/:accountId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/accounts/:accountId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/accounts/:accountId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/accounts/:accountId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/accounts/:accountId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/accounts/:accountId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/accounts/:accountId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/accounts/:accountId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/accounts/:accountId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/accounts/:accountId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/accounts/:accountId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/accounts/:accountId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/accounts/:accountId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/accounts/:accountId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/accounts/:accountId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/accounts/:accountId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/accounts/:accountId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/accounts/:accountId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/accounts/:accountId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/accounts/:accountId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/accounts/:accountId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/accounts/:accountId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/accounts/:accountId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/accounts/:accountId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/accounts/:accountId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/accounts/:accountId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/accounts/:accountId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/accounts/:accountId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/accounts/:accountId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/accounts/:accountIdhttp GET {{baseUrl}}/companies/:companyId/data/accounts/:accountIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/accounts/:accountIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/accounts/:accountId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create account model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/chartOfAccounts HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/chartOfAccounts',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/chartOfAccounts")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/chartOfAccounts') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccountshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccountswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccountsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/chartOfAccounts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Nominal Accounts are the categories a business uses to record transactions",
"displayName": "Nominal Account",
"properties": {
"fullyQualifiedCategory": {
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"displayName": "Fully Qualified Category",
"options": [
{
"displayName": "Asset.Assets.Cash",
"required": false,
"type": "String",
"value": "Asset.Assets.Cash"
},
{
"displayName": "Asset.Assets.Bank",
"required": false,
"type": "String",
"value": "Asset.Assets.Bank"
},
{
"displayName": "Asset.Assets.PaymentServices",
"required": false,
"type": "String",
"value": "Asset.Assets.PaymentServices"
},
{
"displayName": "Asset.Assets.AccountsReceivable",
"required": false,
"type": "String",
"value": "Asset.Assets.AccountsReceivable"
},
{
"displayName": "Liability.EquityAndLiabilities.AccountsPayable",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.AccountsPayable"
},
{
"displayName": "Asset.Assets.VAT",
"required": false,
"type": "String",
"value": "Asset.Assets.VAT"
},
{
"displayName": "Liability.EquityAndLiabilities.EmployeesPayable",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.EmployeesPayable"
},
{
"displayName": "Asset.Assets.PrepaidExpenses",
"required": false,
"type": "String",
"value": "Asset.Assets.PrepaidExpenses"
},
{
"displayName": "Liability.EquityAndLiabilities.AccruedExpenses",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.AccruedExpenses"
},
{
"displayName": "Liability.EquityAndLiabilities.IncomeTaxesPayable",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.IncomeTaxesPayable"
},
{
"displayName": "Asset.Assets.FixedAssets",
"required": false,
"type": "String",
"value": "Asset.Assets.FixedAssets"
},
{
"displayName": "Asset.Assets.OtherAssets",
"required": false,
"type": "String",
"value": "Asset.Assets.OtherAssets"
},
{
"displayName": "Asset.Assets.AccumulatedDeprecation",
"required": false,
"type": "String",
"value": "Asset.Assets.AccumulatedDeprecation"
},
{
"displayName": "Asset.Assets.Inventory",
"required": false,
"type": "String",
"value": "Asset.Assets.Inventory"
},
{
"displayName": "Equity.EquityAndLiabilities.CapitalStock",
"required": false,
"type": "String",
"value": "Equity.EquityAndLiabilities.CapitalStock"
},
{
"displayName": "Equity.EquityAndLiabilities.RetainedEarnings",
"required": false,
"type": "String",
"value": "Equity.EquityAndLiabilities.RetainedEarnings"
},
{
"displayName": "Liability.EquityAndLiabilities.LongTermDebt",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.LongTermDebt"
},
{
"displayName": "Liability.EquityAndLiabilities.CurrentPortionOfDebt",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.CurrentPortionOfDebt"
},
{
"displayName": "Unknown.EquityAndLiabilities.Intercompany",
"required": false,
"type": "String",
"value": "Unknown.EquityAndLiabilities.Intercompany"
},
{
"displayName": "Unknown.General.General",
"required": false,
"type": "String",
"value": "Unknown.General.General"
},
{
"displayName": "Income.NetIncome.Revenue",
"required": false,
"type": "String",
"value": "Income.NetIncome.Revenue"
},
{
"displayName": "Expense.NetIncome.CostOfGoods",
"required": false,
"type": "String",
"value": "Expense.NetIncome.CostOfGoods"
},
{
"displayName": "Expense.NetIncome.OtherCosts",
"required": false,
"type": "String",
"value": "Expense.NetIncome.OtherCosts"
},
{
"displayName": "Expense.NetIncome.SalesGeneralAdministrativeExpenses",
"required": false,
"type": "String",
"value": "Expense.NetIncome.SalesGeneralAdministrativeExpenses"
},
{
"displayName": "Expense.NetIncome.DeprecationCosts",
"required": false,
"type": "String",
"value": "Expense.NetIncome.DeprecationCosts"
},
{
"displayName": "Expense.NetIncome.ResearchAndDevelopment",
"required": false,
"type": "String",
"value": "Expense.NetIncome.ResearchAndDevelopment"
},
{
"displayName": "Expense.NetIncome.EmployeeCosts",
"required": false,
"type": "String",
"value": "Expense.NetIncome.EmployeeCosts"
},
{
"displayName": "Expense.NetIncome.EmploymentCosts",
"required": false,
"type": "String",
"value": "Expense.NetIncome.EmploymentCosts"
},
{
"displayName": "Expense.ExceptionalIncome.ExceptionalCosts",
"required": false,
"type": "String",
"value": "Expense.ExceptionalIncome.ExceptionalCosts"
},
{
"displayName": "Income.ExceptionalIncome.ExceptionalIncome",
"required": false,
"type": "String",
"value": "Income.ExceptionalIncome.ExceptionalIncome"
},
{
"displayName": "Expense.ExceptionalIncome.IncomeTaxes",
"required": false,
"type": "String",
"value": "Expense.ExceptionalIncome.IncomeTaxes"
},
{
"displayName": "Income.ExceptionalIncome.InterestIncome",
"required": false,
"type": "String",
"value": "Income.ExceptionalIncome.InterestIncome"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "FullyQualifiedCategory"
}
],
"warnings": []
}
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Name"
}
],
"warnings": []
}
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "NominalCode"
}
],
"warnings": []
}
},
"status": {
"description": "The status of the account",
"displayName": "Account Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Pending",
"required": false,
"type": "String",
"value": "Pending"
},
{
"displayName": "Unknown",
"required": false,
"type": "String",
"value": "Unknown"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Status"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Nominal Accounts are the categories a business uses to record transactions",
"displayName": "Nominal Account",
"properties": {
"fullyQualifiedCategory": {
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"displayName": "Fully Qualified Category",
"options": [
{
"displayName": "Asset.Assets.Cash",
"required": false,
"type": "String",
"value": "Asset.Assets.Cash"
},
{
"displayName": "Asset.Assets.Bank",
"required": false,
"type": "String",
"value": "Asset.Assets.Bank"
},
{
"displayName": "Asset.Assets.PaymentServices",
"required": false,
"type": "String",
"value": "Asset.Assets.PaymentServices"
},
{
"displayName": "Asset.Assets.AccountsReceivable",
"required": false,
"type": "String",
"value": "Asset.Assets.AccountsReceivable"
},
{
"displayName": "Liability.EquityAndLiabilities.AccountsPayable",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.AccountsPayable"
},
{
"displayName": "Asset.Assets.VAT",
"required": false,
"type": "String",
"value": "Asset.Assets.VAT"
},
{
"displayName": "Liability.EquityAndLiabilities.EmployeesPayable",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.EmployeesPayable"
},
{
"displayName": "Asset.Assets.PrepaidExpenses",
"required": false,
"type": "String",
"value": "Asset.Assets.PrepaidExpenses"
},
{
"displayName": "Liability.EquityAndLiabilities.AccruedExpenses",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.AccruedExpenses"
},
{
"displayName": "Liability.EquityAndLiabilities.IncomeTaxesPayable",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.IncomeTaxesPayable"
},
{
"displayName": "Asset.Assets.FixedAssets",
"required": false,
"type": "String",
"value": "Asset.Assets.FixedAssets"
},
{
"displayName": "Asset.Assets.OtherAssets",
"required": false,
"type": "String",
"value": "Asset.Assets.OtherAssets"
},
{
"displayName": "Asset.Assets.AccumulatedDeprecation",
"required": false,
"type": "String",
"value": "Asset.Assets.AccumulatedDeprecation"
},
{
"displayName": "Asset.Assets.Inventory",
"required": false,
"type": "String",
"value": "Asset.Assets.Inventory"
},
{
"displayName": "Equity.EquityAndLiabilities.CapitalStock",
"required": false,
"type": "String",
"value": "Equity.EquityAndLiabilities.CapitalStock"
},
{
"displayName": "Equity.EquityAndLiabilities.RetainedEarnings",
"required": false,
"type": "String",
"value": "Equity.EquityAndLiabilities.RetainedEarnings"
},
{
"displayName": "Liability.EquityAndLiabilities.LongTermDebt",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.LongTermDebt"
},
{
"displayName": "Liability.EquityAndLiabilities.CurrentPortionOfDebt",
"required": false,
"type": "String",
"value": "Liability.EquityAndLiabilities.CurrentPortionOfDebt"
},
{
"displayName": "Unknown.EquityAndLiabilities.Intercompany",
"required": false,
"type": "String",
"value": "Unknown.EquityAndLiabilities.Intercompany"
},
{
"displayName": "Unknown.General.General",
"required": false,
"type": "String",
"value": "Unknown.General.General"
},
{
"displayName": "Income.NetIncome.Revenue",
"required": false,
"type": "String",
"value": "Income.NetIncome.Revenue"
},
{
"displayName": "Expense.NetIncome.CostOfGoods",
"required": false,
"type": "String",
"value": "Expense.NetIncome.CostOfGoods"
},
{
"displayName": "Expense.NetIncome.OtherCosts",
"required": false,
"type": "String",
"value": "Expense.NetIncome.OtherCosts"
},
{
"displayName": "Expense.NetIncome.SalesGeneralAdministrativeExpenses",
"required": false,
"type": "String",
"value": "Expense.NetIncome.SalesGeneralAdministrativeExpenses"
},
{
"displayName": "Expense.NetIncome.DeprecationCosts",
"required": false,
"type": "String",
"value": "Expense.NetIncome.DeprecationCosts"
},
{
"displayName": "Expense.NetIncome.ResearchAndDevelopment",
"required": false,
"type": "String",
"value": "Expense.NetIncome.ResearchAndDevelopment"
},
{
"displayName": "Expense.NetIncome.EmployeeCosts",
"required": false,
"type": "String",
"value": "Expense.NetIncome.EmployeeCosts"
},
{
"displayName": "Expense.NetIncome.EmploymentCosts",
"required": false,
"type": "String",
"value": "Expense.NetIncome.EmploymentCosts"
},
{
"displayName": "Expense.ExceptionalIncome.ExceptionalCosts",
"required": false,
"type": "String",
"value": "Expense.ExceptionalIncome.ExceptionalCosts"
},
{
"displayName": "Income.ExceptionalIncome.ExceptionalIncome",
"required": false,
"type": "String",
"value": "Income.ExceptionalIncome.ExceptionalIncome"
},
{
"displayName": "Expense.ExceptionalIncome.IncomeTaxes",
"required": false,
"type": "String",
"value": "Expense.ExceptionalIncome.IncomeTaxes"
},
{
"displayName": "Income.ExceptionalIncome.InterestIncome",
"required": false,
"type": "String",
"value": "Income.ExceptionalIncome.InterestIncome"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "FullyQualifiedCategory"
}
],
"warnings": []
}
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Name"
}
],
"warnings": []
}
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "NominalCode"
}
],
"warnings": []
}
},
"status": {
"description": "The status of the account",
"displayName": "Account Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Pending",
"required": false,
"type": "String",
"value": "Pending"
},
{
"displayName": "Unknown",
"required": false,
"type": "String",
"value": "Unknown"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Status"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Nominal Accounts are the categories a business uses to record transactions",
"displayName": "Nominal Account",
"properties": {
"description": {
"description": "Description of the account",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "Description"
}
]
}
},
"fullyQualifiedCategory": {
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"displayName": "Fully Qualified Category",
"options": [
{
"displayName": "Bank",
"required": false,
"type": "String",
"value": "Asset.Bank"
},
{
"displayName": "Accounts Receivable",
"required": false,
"type": "String",
"value": "Asset.AccountReceivable"
},
{
"displayName": "Other Current Asset",
"required": false,
"type": "String",
"value": "Asset.OtherCurrentAsset"
},
{
"displayName": "Fixed Asset",
"required": false,
"type": "String",
"value": "Asset.FixedAsset"
},
{
"displayName": "Other Asset",
"required": false,
"type": "String",
"value": "Asset.OtherAsset"
},
{
"displayName": "Cash",
"required": false,
"type": "String",
"value": "Asset.CashAndBank"
},
{
"displayName": "Equipment Machinery",
"required": false,
"type": "String",
"value": "Asset.Property Plant and Equipment"
},
{
"displayName": "Credit Card",
"required": false,
"type": "String",
"value": "Liability.CreditCard"
},
{
"displayName": "Accounts Payable",
"required": false,
"type": "String",
"value": "Liability.AccountsPayable"
},
{
"displayName": "Other Current Liability",
"required": false,
"type": "String",
"value": "Liability.OtherCurrentLiability"
},
{
"displayName": "Long Term Liability",
"required": false,
"type": "String",
"value": "Liability.LongTermLiability"
},
{
"displayName": "Other Liability",
"required": false,
"type": "String",
"value": "Liability.OtherLiability"
},
{
"displayName": "Equity",
"required": false,
"type": "String",
"value": "Equity"
},
{
"displayName": "Retained Earnings",
"required": false,
"type": "String",
"value": "Equity.Equity"
},
{
"displayName": "Retained Earnings",
"required": false,
"type": "String",
"value": "Equity.Equity.RetainedEarnings"
},
{
"displayName": "Retained Earnings",
"required": false,
"type": "String",
"value": "Equity.Owner's Equity"
},
{
"displayName": "Income",
"required": false,
"type": "String",
"value": "Income"
},
{
"displayName": "Other Income",
"required": false,
"type": "String",
"value": "OtherIncome"
},
{
"displayName": "Expense",
"required": false,
"type": "String",
"value": "Expense"
},
{
"displayName": "Sales Marketing",
"required": false,
"type": "String",
"value": "Expense.Expense"
},
{
"displayName": "General Administrative",
"required": false,
"type": "String",
"value": "Expense.Expense.Insurance"
},
{
"displayName": "General Administrative",
"required": false,
"type": "String",
"value": "Expense.Overhead"
},
{
"displayName": "Repairs Maintenance",
"required": false,
"type": "String",
"value": "Expense.Expense.RepairMaintenance"
},
{
"displayName": "Other Expense",
"required": false,
"type": "String",
"value": "OtherExpense"
},
{
"displayName": "Cost of Sales",
"required": false,
"type": "String",
"value": "CostOfSales"
},
{
"displayName": "Other",
"required": false,
"type": "String",
"value": "Cost Of Goods Sold.Cost of Sales"
}
],
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 60 characters",
"field": "Name"
}
]
}
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx",
"field": "NominalCode"
}
]
}
},
"status": {
"description": "The status of the account",
"displayName": "Account Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Nominal Accounts are the categories a business uses to record transactions",
"displayName": "Nominal Account",
"properties": {
"currency": {
"description": "The currency of the account",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the base currency of the QuickBooks Desktop company",
"field": "Currency"
}
],
"warnings": [
{
"details": "The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is 'Asset.AccountsReceivable','Liability.AccountsPayable' or 'Liability.CreditCard'",
"field": "Currency"
},
{
"details": "Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company",
"field": "Currency"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "Currency"
}
]
}
},
"currentBalance": {
"description": "The current balance in the account",
"displayName": "Current Balance",
"required": false,
"type": "Number"
},
"description": {
"description": "Description of the account",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 200 characters.",
"field": "Description"
}
]
}
},
"fullyQualifiedCategory": {
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"displayName": "Fully Qualified Category",
"options": [
{
"displayName": "Account Receivable",
"required": false,
"type": "String",
"value": "Asset.AccountsReceivable"
},
{
"displayName": "Fixed Asset",
"required": false,
"type": "String",
"value": "Asset.FixedAsset"
},
{
"displayName": "Other Current Asset",
"required": false,
"type": "String",
"value": "Asset.OtherCurrentAsset"
},
{
"displayName": "Other Asset",
"required": false,
"type": "String",
"value": "Asset.OtherAsset"
},
{
"displayName": "Income",
"required": false,
"type": "String",
"value": "Income.Income"
},
{
"displayName": "Other Income",
"required": false,
"type": "String",
"value": "Income.OtherIncome"
},
{
"displayName": "Accounts Payable",
"required": false,
"type": "String",
"value": "Liability.AccountsPayable"
},
{
"displayName": "Credit Card",
"required": false,
"type": "String",
"value": "Liability.CreditCard"
},
{
"displayName": "Long Term Liability",
"required": false,
"type": "String",
"value": "Liability.LongTermLiability"
},
{
"displayName": "Other Current Liability",
"required": false,
"type": "String",
"value": "Liability.OtherCurrentLiability"
},
{
"displayName": "Cost Of Goods Sold",
"required": false,
"type": "String",
"value": "Liability.CostOfGoodsSold"
},
{
"displayName": "Equity",
"required": false,
"type": "String",
"value": "Equity.Equity"
},
{
"displayName": "Expense",
"required": false,
"type": "String",
"value": "Expense.Expense"
},
{
"displayName": "Other Expense",
"required": false,
"type": "String",
"value": "Expense.OtherExpense"
}
],
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 31 characters.",
"field": "Name"
}
]
}
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 7 characters.",
"field": "NominalCode"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Nominal Accounts are the categories a business uses to record transactions",
"displayName": "Nominal Account",
"properties": {
"currency": {
"description": "The currency of the account",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "When not specified company base currency will be used",
"field": "Currency"
}
],
"warnings": []
}
},
"fullyQualifiedCategory": {
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"displayName": "Fully Qualified Category",
"options": [
{
"displayName": "Cash On Hand",
"required": false,
"type": "String",
"value": "Asset.Bank.CashOnHand"
},
{
"displayName": "Checking",
"required": false,
"type": "String",
"value": "Asset.Bank.Checking"
},
{
"displayName": "Money Market",
"required": false,
"type": "String",
"value": "Asset.Bank.MoneyMarket"
},
{
"displayName": "Rents Held In Trust",
"required": false,
"type": "String",
"value": "Asset.Bank.RentsHeldInTrust"
},
{
"displayName": "Savings",
"required": false,
"type": "String",
"value": "Asset.Bank.Savings"
},
{
"displayName": "Trust Accounts",
"required": false,
"type": "String",
"value": "Asset.Bank.TrustAccounts"
},
{
"displayName": "Cash And Cash Equivalents",
"required": false,
"type": "String",
"value": "Asset.Bank.CashAndCashEquivalents"
},
{
"displayName": "Other Earmarked Bank Accounts",
"required": false,
"type": "String",
"value": "Asset.Bank.OtherEarmarkedBankAccounts"
},
{
"displayName": "Allowance For Bad Debts",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.AllowanceForBadDebts"
},
{
"displayName": "Development Costs",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.DevelopmentCosts"
},
{
"displayName": "Employee Cash Advances",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.EmployeeCashAdvances"
},
{
"displayName": "Other Current Assets",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.OtherCurrentAssets"
},
{
"displayName": "Inventory",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Inventory"
},
{
"displayName": "Investment Mortgage Real Estate Loans",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Investment_MortgageRealEstateLoans"
},
{
"displayName": "Investment Other",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Investment_Other"
},
{
"displayName": "Investment Tax Exempt Securities",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Investment_TaxExemptSecurities"
},
{
"displayName": "Investment US Government Obligations",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Investment_USGovernmentObligations"
},
{
"displayName": "Loans To Officers",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.LoansToOfficers"
},
{
"displayName": "Loans To Others",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.LoansToOthers"
},
{
"displayName": "Loans To Stockholders",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.LoansToStockholders"
},
{
"displayName": "Prepaid Expenses",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.PrepaidExpenses"
},
{
"displayName": "Retainage",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Retainage"
},
{
"displayName": "Undeposited Funds",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.UndepositedFunds"
},
{
"displayName": "Assets Available For Sale",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.AssetsAvailableForSale"
},
{
"displayName": "Balance With Govt Authorities",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.BalWithGovtAuthorities"
},
{
"displayName": "Called Up Share Capital Not Paid",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.CalledUpShareCapitalNotPaid"
},
{
"displayName": "Expenditure Authorisations And Letters Of Credit",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit"
},
{
"displayName": "Global Tax Deferred",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.GlobalTaxDeferred"
},
{
"displayName": "Global Tax Refund",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.GlobalTaxRefund"
},
{
"displayName": "Internal Transfers",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.InternalTransfers"
},
{
"displayName": "Other Consumables",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.OtherConsumables"
},
{
"displayName": "Provisions Current Assets",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.ProvisionsCurrentAssets"
},
{
"displayName": "Short Term Investments In Related Parties",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties"
},
{
"displayName": "Short Term Loans And Advances To Related Parties",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties"
},
{
"displayName": "Trade And Other Receivables",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.TradeAndOtherReceivables"
},
{
"displayName": "Accumulated Depletion",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.AccumulatedDepletion"
},
{
"displayName": "Accumulated Depreciation",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.AccumulatedDepreciation"
},
{
"displayName": "Depletable Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.DepletableAssets"
},
{
"displayName": "Fixed Asset Computers",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetComputers"
},
{
"displayName": "Fixed Asset Copiers",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetCopiers"
},
{
"displayName": "Fixed Asset Furniture",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetFurniture"
},
{
"displayName": "Fixed Asset Phone",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetPhone"
},
{
"displayName": "Fixed Asset Photo Video",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetPhotoVideo"
},
{
"displayName": "Fixed Asset Software",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetSoftware"
},
{
"displayName": "Fixed Asset Other Tools Equipment",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetOtherToolsEquipment"
},
{
"displayName": "Furniture And Fixtures",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FurnitureAndFixtures"
},
{
"displayName": "Land",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.Land"
},
{
"displayName": "Leasehold Improvements",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.LeaseholdImprovements"
},
{
"displayName": "Other Fixed Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.OtherFixedAssets"
},
{
"displayName": "Accumulated Amortization",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.AccumulatedAmortization"
},
{
"displayName": "Buildings",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.Buildings"
},
{
"displayName": "Intangible Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.IntangibleAssets"
},
{
"displayName": "Machinery And Equipment",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.MachineryAndEquipment"
},
{
"displayName": "Vehicles",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.Vehicles"
},
{
"displayName": "Assets In Course Of Construction",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.AssetsInCourseOfConstruction"
},
{
"displayName": "Capital Wip",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.CapitalWip"
},
{
"displayName": "Cumulative Depreciation On Intangible Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets"
},
{
"displayName": "Intangible Assets Under Development",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.IntangibleAssetsUnderDevelopment"
},
{
"displayName": "Land Asset",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.LandAsset"
},
{
"displayName": "Non Current Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.NonCurrentAssets"
},
{
"displayName": "Participating Interests",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.ParticipatingInterests"
},
{
"displayName": "Provisions Fixed Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.ProvisionsFixedAssets"
},
{
"displayName": "Lease Buyout",
"required": false,
"type": "String",
"value": "Asset.Other Asset.LeaseBuyout"
},
{
"displayName": "Other Long Term Assets",
"required": false,
"type": "String",
"value": "Asset.Other Asset.OtherLongTermAssets"
},
{
"displayName": "Security Deposits",
"required": false,
"type": "String",
"value": "Asset.Other Asset.SecurityDeposits"
},
{
"displayName": "Accumulated Amortization Of Other Assets",
"required": false,
"type": "String",
"value": "Asset.Other Asset.AccumulatedAmortizationOfOtherAssets"
},
{
"displayName": "Goodwill",
"required": false,
"type": "String",
"value": "Asset.Other Asset.Goodwill"
},
{
"displayName": "Licenses",
"required": false,
"type": "String",
"value": "Asset.Other Asset.Licenses"
},
{
"displayName": "Organizational Costs",
"required": false,
"type": "String",
"value": "Asset.Other Asset.OrganizationalCosts"
},
{
"displayName": "Assets Held For Sale",
"required": false,
"type": "String",
"value": "Asset.Other Asset.AssetsHeldForSale"
},
{
"displayName": "Available For Sale Financial Assets",
"required": false,
"type": "String",
"value": "Asset.Other Asset.AvailableForSaleFinancialAssets"
},
{
"displayName": "Deferred Tax",
"required": false,
"type": "String",
"value": "Asset.Other Asset.DeferredTax"
},
{
"displayName": "Investments",
"required": false,
"type": "String",
"value": "Asset.Other Asset.Investments"
},
{
"displayName": "Long Term Investments",
"required": false,
"type": "String",
"value": "Asset.Other Asset.LongTermInvestments"
},
{
"displayName": "Long Term Loans And Advances To Related Parties",
"required": false,
"type": "String",
"value": "Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties"
},
{
"displayName": "Other Intangible Assets",
"required": false,
"type": "String",
"value": "Asset.Other Asset.OtherIntangibleAssets"
},
{
"displayName": "Other Long Term Investments",
"required": false,
"type": "String",
"value": "Asset.Other Asset.OtherLongTermInvestments"
},
{
"displayName": "Other Long Term Loans And Advances",
"required": false,
"type": "String",
"value": "Asset.Other Asset.OtherLongTermLoansAndAdvances"
},
{
"displayName": "Prepayments And Accrued Income",
"required": false,
"type": "String",
"value": "Asset.Other Asset.PrepaymentsAndAccruedIncome"
},
{
"displayName": "Provisions Non-Current Assets",
"required": false,
"type": "String",
"value": "Asset.Other Asset.ProvisionsNonCurrentAssets"
},
{
"displayName": "Accounts Receivable",
"required": false,
"type": "String",
"value": "Asset.Accounts Receivable.AccountsReceivable"
},
{
"displayName": "Advertising/Promotional",
"required": false,
"type": "String",
"value": "Expense.Expense.AdvertisingPromotional"
},
{
"displayName": "Bad Debts",
"required": false,
"type": "String",
"value": "Expense.Expense.BadDebts"
},
{
"displayName": "Bank Charges",
"required": false,
"type": "String",
"value": "Expense.Expense.BankCharges"
},
{
"displayName": "Charitable Contributions",
"required": false,
"type": "String",
"value": "Expense.Expense.CharitableContributions"
},
{
"displayName": "Commissions And Fees",
"required": false,
"type": "String",
"value": "Expense.Expense.CommissionsAndFees"
},
{
"displayName": "Entertainment",
"required": false,
"type": "String",
"value": "Expense.Expense.Entertainment"
},
{
"displayName": "Entertainment Meals",
"required": false,
"type": "String",
"value": "Expense.Expense.EntertainmentMeals"
},
{
"displayName": "Equipment Rental",
"required": false,
"type": "String",
"value": "Expense.Expense.EquipmentRental"
},
{
"displayName": "Finance Costs",
"required": false,
"type": "String",
"value": "Expense.Expense.FinanceCosts"
},
{
"displayName": "Global Tax Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.GlobalTaxExpense"
},
{
"displayName": "Insurance",
"required": false,
"type": "String",
"value": "Expense.Expense.Insurance"
},
{
"displayName": "Interest Paid",
"required": false,
"type": "String",
"value": "Expense.Expense.InterestPaid"
},
{
"displayName": "Legal And Professional Fees",
"required": false,
"type": "String",
"value": "Expense.Expense.LegalProfessionalFees"
},
{
"displayName": "Office Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.OfficeExpenses"
},
{
"displayName": "Office/General Administrative Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.OfficeGeneralAdministrativeExpenses"
},
{
"displayName": "Other Business Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherBusinessExpenses"
},
{
"displayName": "Other Miscellaneous Service Cost",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherMiscellaneousServiceCost"
},
{
"displayName": "Promotional Meals",
"required": false,
"type": "String",
"value": "Expense.Expense.PromotionalMeals"
},
{
"displayName": "Rent Or Lease Of Buildings",
"required": false,
"type": "String",
"value": "Expense.Expense.RentOrLeaseOfBuildings"
},
{
"displayName": "Repair And Maintenance",
"required": false,
"type": "String",
"value": "Expense.Expense.RepairMaintenance"
},
{
"displayName": "Shipping, Freight And Delivery",
"required": false,
"type": "String",
"value": "Expense.Expense.ShippingFreightDelivery"
},
{
"displayName": "Supplies And Materials",
"required": false,
"type": "String",
"value": "Expense.Expense.SuppliesMaterials"
},
{
"displayName": "Travel",
"required": false,
"type": "String",
"value": "Expense.Expense.Travel"
},
{
"displayName": "Travel Meals",
"required": false,
"type": "String",
"value": "Expense.Expense.TravelMeals"
},
{
"displayName": "Utilities",
"required": false,
"type": "String",
"value": "Expense.Expense.Utilities"
},
{
"displayName": "Auto",
"required": false,
"type": "String",
"value": "Expense.Expense.Auto"
},
{
"displayName": "Cost Of Labor",
"required": false,
"type": "String",
"value": "Expense.Expense.CostOfLabor"
},
{
"displayName": "Dues And Subscriptions",
"required": false,
"type": "String",
"value": "Expense.Expense.DuesSubscriptions"
},
{
"displayName": "Payroll Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.PayrollExpenses"
},
{
"displayName": "Taxes Paid",
"required": false,
"type": "String",
"value": "Expense.Expense.TaxesPaid"
},
{
"displayName": "Unapplied Cash Bill Payment Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.UnappliedCashBillPaymentExpense"
},
{
"displayName": "Utilities",
"required": false,
"type": "String",
"value": "Expense.Expense.Utilities"
},
{
"displayName": "Amortization Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.AmortizationExpense"
},
{
"displayName": "Appropriations To Depreciation",
"required": false,
"type": "String",
"value": "Expense.Expense.AppropriationsToDepreciation"
},
{
"displayName": "Borrowing Cost",
"required": false,
"type": "String",
"value": "Expense.Expense.BorrowingCost"
},
{
"displayName": "Commissions And Fees",
"required": false,
"type": "String",
"value": "Expense.Expense.CommissionsAndFees"
},
{
"displayName": "Distribution Costs",
"required": false,
"type": "String",
"value": "Expense.Expense.DistributionCosts"
},
{
"displayName": "External Services",
"required": false,
"type": "String",
"value": "Expense.Expense.ExternalServices"
},
{
"displayName": "Extraordinary Charges",
"required": false,
"type": "String",
"value": "Expense.Expense.ExtraordinaryCharges"
},
{
"displayName": "Income Tax Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.IncomeTaxExpense"
},
{
"displayName": "Loss On Discontinued Operations Net Of Tax",
"required": false,
"type": "String",
"value": "Expense.Expense.LossOnDiscontinuedOperationsNetOfTax"
},
{
"displayName": "Management Compensation",
"required": false,
"type": "String",
"value": "Expense.Expense.ManagementCompensation"
},
{
"displayName": "Other Current Operating Charges",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherCurrentOperatingCharges"
},
{
"displayName": "Other External Services",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherExternalServices"
},
{
"displayName": "Other Rental Costs",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherRentalCosts"
},
{
"displayName": "Other Selling Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherSellingExpenses"
},
{
"displayName": "Project Studies Surveys Assessments",
"required": false,
"type": "String",
"value": "Expense.Expense.ProjectStudiesSurveysAssessments"
},
{
"displayName": "Purchases Rebates",
"required": false,
"type": "String",
"value": "Expense.Expense.PurchasesRebates"
},
{
"displayName": "Shipping And Delivery Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.ShippingAndDeliveryExpense"
},
{
"displayName": "Staff Costs",
"required": false,
"type": "String",
"value": "Expense.Expense.StaffCosts"
},
{
"displayName": "Sundry",
"required": false,
"type": "String",
"value": "Expense.Expense.Sundry"
},
{
"displayName": "Travel Expenses General And Admin Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.TravelExpensesGeneralAndAdminExpenses"
},
{
"displayName": "Travel Expenses Selling Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.TravelExpensesSellingExpense"
},
{
"displayName": "Depreciation",
"required": false,
"type": "String",
"value": "Expense.Other Expense.Depreciation"
},
{
"displayName": "Exchange Gain Or Loss",
"required": false,
"type": "String",
"value": "Expense.Other Expense.ExchangeGainOrLoss"
},
{
"displayName": "Other Miscellaneous Expense",
"required": false,
"type": "String",
"value": "Expense.Other Expense.OtherMiscellaneousExpense"
},
{
"displayName": "Penalties And Settlements",
"required": false,
"type": "String",
"value": "Expense.Other Expense.PenaltiesSettlements"
},
{
"displayName": "Amortization",
"required": false,
"type": "String",
"value": "Expense.Other Expense.Amortization"
},
{
"displayName": "Gas And Fuel",
"required": false,
"type": "String",
"value": "Expense.Other Expense.GasAndFuel"
},
{
"displayName": "Home Office",
"required": false,
"type": "String",
"value": "Expense.Other Expense.HomeOffice"
},
{
"displayName": "Home Owner Rental Insurance",
"required": false,
"type": "String",
"value": "Expense.Other Expense.HomeOwnerRentalInsurance"
},
{
"displayName": "Other Home Office Expenses",
"required": false,
"type": "String",
"value": "Expense.Other Expense.OtherHomeOfficeExpenses"
},
{
"displayName": "Mortgage Interest",
"required": false,
"type": "String",
"value": "Expense.Other Expense.MortgageInterest"
},
{
"displayName": "Rent And Lease",
"required": false,
"type": "String",
"value": "Expense.Other Expense.RentAndLease"
},
{
"displayName": "Repairs And Maintenance",
"required": false,
"type": "String",
"value": "Expense.Other Expense.RepairsAndMaintenance"
},
{
"displayName": "Parking And Tolls",
"required": false,
"type": "String",
"value": "Expense.Other Expense.ParkingAndTolls"
},
{
"displayName": "Vehicle",
"required": false,
"type": "String",
"value": "Expense.Other Expense.Vehicle"
},
{
"displayName": "Vehicle Insurance",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleInsurance"
},
{
"displayName": "Vehicle Lease",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleLease"
},
{
"displayName": "Vehicle Loan Interest",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleLoanInterest"
},
{
"displayName": "Vehicle Loan",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleLoan"
},
{
"displayName": "Vehicle Registration",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleRegistration"
},
{
"displayName": "Vehicle Repairs",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleRepairs"
},
{
"displayName": "Other Vehicle Expenses",
"required": false,
"type": "String",
"value": "Expense.Other Expense.OtherVehicleExpenses"
},
{
"displayName": "Utilities",
"required": false,
"type": "String",
"value": "Expense.Other Expense.Utilities"
},
{
"displayName": "Wash And Road Services",
"required": false,
"type": "String",
"value": "Expense.Other Expense.WashAndRoadServices"
},
{
"displayName": "Deferred Tax Expense",
"required": false,
"type": "String",
"value": "Expense.Other Expense.DeferredTaxExpense"
},
{
"displayName": "Depletion",
"required": false,
"type": "String",
"value": "Expense.Other Expense.Depletion"
},
{
"displayName": "Exceptional Items",
"required": false,
"type": "String",
"value": "Expense.Other Expense.ExceptionalItems"
},
{
"displayName": "Extraordinary Items",
"required": false,
"type": "String",
"value": "Expense.Other Expense.ExtraordinaryItems"
},
{
"displayName": "Income Tax Other Expense",
"required": false,
"type": "String",
"value": "Expense.Other Expense.IncomeTaxOtherExpense"
},
{
"displayName": "Mat Credit",
"required": false,
"type": "String",
"value": "Expense.Other Expense.MatCredit"
},
{
"displayName": "Prior Period Items",
"required": false,
"type": "String",
"value": "Expense.Other Expense.PriorPeriodItems"
},
{
"displayName": "Tax Roundoff Gain Or Loss",
"required": false,
"type": "String",
"value": "Expense.Other Expense.TaxRoundoffGainOrLoss"
},
{
"displayName": "Equipment Rental - COS",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.EquipmentRentalCos"
},
{
"displayName": "Other Costs Of Sales - COS",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.OtherCostsOfServiceCos"
},
{
"displayName": "Shipping, Freight And Delivery - COS",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.ShippingFreightDeliveryCos"
},
{
"displayName": "Supplies And Materials - COS",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.SuppliesMaterialsCogs"
},
{
"displayName": "Cost Of Labor - COS",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.CostOfLaborCos"
},
{
"displayName": "Cost Of Sales",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.CostOfSales"
},
{
"displayName": "Freight And Delivery Cost",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.FreightAndDeliveryCost"
},
{
"displayName": "Non Profit Income",
"required": false,
"type": "String",
"value": "Income.Income.NonProfitIncome"
},
{
"displayName": "Other Primary Income",
"required": false,
"type": "String",
"value": "Income.Income.OtherPrimaryIncome"
},
{
"displayName": "Sales Of ProductIncome",
"required": false,
"type": "String",
"value": "Income.Income.SalesOfProductIncome"
},
{
"displayName": "Service Fee Income",
"required": false,
"type": "String",
"value": "Income.Income.ServiceFeeIncome"
},
{
"displayName": "Discounts Refunds Given",
"required": false,
"type": "String",
"value": "Income.Income.DiscountsRefundsGiven"
},
{
"displayName": "Unapplied Cash Payment Income",
"required": false,
"type": "String",
"value": "Income.Income.UnappliedCashPaymentIncome"
},
{
"displayName": "Cash Receipt Income",
"required": false,
"type": "String",
"value": "Income.Income.CashReceiptIncome"
},
{
"displayName": "Operating Grants",
"required": false,
"type": "String",
"value": "Income.Income.OperatingGrants"
},
{
"displayName": "Other Current Operating Income",
"required": false,
"type": "String",
"value": "Income.Income.OtherCurrentOperatingIncome"
},
{
"displayName": "Own Work Capitalized",
"required": false,
"type": "String",
"value": "Income.Income.OwnWorkCapitalized"
},
{
"displayName": "Revenue General",
"required": false,
"type": "String",
"value": "Income.Income.RevenueGeneral"
},
{
"displayName": "Sales Retail",
"required": false,
"type": "String",
"value": "Income.Income.SalesRetail"
},
{
"displayName": "Sales Wholesale",
"required": false,
"type": "String",
"value": "Income.Income.SalesWholesale"
},
{
"displayName": "Savings By Tax Scheme",
"required": false,
"type": "String",
"value": "Income.Income.SavingsByTaxScheme"
},
{
"displayName": "Dividend Income",
"required": false,
"type": "String",
"value": "Income.Other Income.DividendIncome"
},
{
"displayName": "Interest Earned",
"required": false,
"type": "String",
"value": "Income.Other Income.InterestEarned"
},
{
"displayName": "Other Investment Income",
"required": false,
"type": "String",
"value": "Income.Other Income.OtherInvestmentIncome"
},
{
"displayName": "Other Miscellaneous Income",
"required": false,
"type": "String",
"value": "Income.Other Income.OtherMiscellaneousIncome"
},
{
"displayName": "Tax Exempt Interest",
"required": false,
"type": "String",
"value": "Income.Other Income.TaxExemptInterest"
},
{
"displayName": "Gain Loss On Sale Of Fixed Assets",
"required": false,
"type": "String",
"value": "Income.Other Income.GainLossOnSaleOfFixedAssets"
},
{
"displayName": "Gain Loss On Sale Of Investments",
"required": false,
"type": "String",
"value": "Income.Other Income.GainLossOnSaleOfInvestments"
},
{
"displayName": "Loss On Disposal Of Assets",
"required": false,
"type": "String",
"value": "Income.Other Income.LossOnDisposalOfAssets"
},
{
"displayName": "Other Operating Income",
"required": false,
"type": "String",
"value": "Income.Other Income.OtherOperatingIncome"
},
{
"displayName": "Unrealised Loss On Securities Net Of Tax",
"required": false,
"type": "String",
"value": "Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax"
},
{
"displayName": "Accounts Payable",
"required": false,
"type": "String",
"value": "Liability.Accounts Payable.AccountsPayable"
},
{
"displayName": "Outstanding Dues Micro Small Enterprise",
"required": false,
"type": "String",
"value": "Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise"
},
{
"displayName": "Outstanding Dues Other Than Micro Small Enterprise",
"required": false,
"type": "String",
"value": "Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise"
},
{
"displayName": "Credit Card",
"required": false,
"type": "String",
"value": "Liability.Credit Card.CreditCard"
},
{
"displayName": "Notes Payable",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.NotesPayable"
},
{
"displayName": "Other Long Term Liabilities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.OtherLongTermLiabilities"
},
{
"displayName": "Shareholder Notes Payable",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.ShareholderNotesPayable"
},
{
"displayName": "Accruals And Deferred Income",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.AccrualsAndDeferredIncome"
},
{
"displayName": "Accrued Long Lerm Liabilities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.AccruedLongLermLiabilities"
},
{
"displayName": "Accrued Vacation Payable",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.AccruedVacationPayable"
},
{
"displayName": "Bank Loans",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.BankLoans"
},
{
"displayName": "Debts Related To Participating Interests",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.DebtsRelatedToParticipatingInterests"
},
{
"displayName": "Deferred Tax Liabilities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.DeferredTaxLiabilities"
},
{
"displayName": "Government And Other Public Authorities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities"
},
{
"displayName": "Group And Associates",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.GroupAndAssociates"
},
{
"displayName": "Liabilities Related To Assets Held For Sale",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale"
},
{
"displayName": "Long Term Borrowings",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.LongTermBorrowings"
},
{
"displayName": "Long Term Debit",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.LongTermDebit"
},
{
"displayName": "Long Term Employee Benefit Obligations",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.LongTermEmployeeBenefitObligations"
},
{
"displayName": "Obligations Under Finance Leases",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.ObligationsUnderFinanceLeases"
},
{
"displayName": "Other Long Term Provisions",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.OtherLongTermProvisions"
},
{
"displayName": "Provision For Liabilities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.ProvisionForLiabilities"
},
{
"displayName": "Provisions Non Current Liabilities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.ProvisionsNonCurrentLiabilities"
},
{
"displayName": "Staff And Related Long Term Liability Accounts",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts"
},
{
"displayName": "Direct Deposit Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.DirectDepositPayable"
},
{
"displayName": "Line Of Credit",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.LineOfCredit"
},
{
"displayName": "Loan Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.LoanPayable"
},
{
"displayName": "Global Tax Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.GlobalTaxPayable"
},
{
"displayName": "Global Tax Suspense",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.GlobalTaxSuspense"
},
{
"displayName": "Other Current Liabilities",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.OtherCurrentLiabilities"
},
{
"displayName": "Payroll Clearing",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.PayrollClearing"
},
{
"displayName": "Payroll Tax Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.PayrollTaxPayable"
},
{
"displayName": "Prepaid Expenses Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.PrepaidExpensesPayable"
},
{
"displayName": "Rents In Trust Liability",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.RentsInTrustLiability"
},
{
"displayName": "Trust Accounts Liabilities",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.TrustAccountsLiabilities"
},
{
"displayName": "Federal Income Tax Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.FederalIncomeTaxPayable"
},
{
"displayName": "Insurance Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.InsurancePayable"
},
{
"displayName": "Sales Tax Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.SalesTaxPayable"
},
{
"displayName": "State Local Income Tax Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.StateLocalIncomeTaxPayable"
},
{
"displayName": "Accrued Liabilities",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.AccruedLiabilities"
},
{
"displayName": "Current Liabilities",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.CurrentLiabilities"
},
{
"displayName": "Current Portion EmployeeBenefits Obligations",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations"
},
{
"displayName": "Current Portion Of Obligations Under Finance Leases",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases"
},
{
"displayName": "Current Tax Liability",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.CurrentTaxLiability"
},
{
"displayName": "Dividends Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.DividendsPayable"
},
{
"displayName": "Duties And Taxes",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.DutiesAndTaxes"
},
{
"displayName": "Interest Payables",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.InterestPayables"
},
{
"displayName": "Provision For Warranty Obligations",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.ProvisionForWarrantyObligations"
},
{
"displayName": "Provisions Current Liabilities",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.ProvisionsCurrentLiabilities"
},
{
"displayName": "Short Term Borrowings",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.ShortTermBorrowings"
},
{
"displayName": "Social Security Agencies",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.SocialSecurityAgencies"
},
{
"displayName": "Staff And Related Liability Accounts",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts"
},
{
"displayName": "Sundry Debtors And Creditors",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.SundryDebtorsAndCreditors"
},
{
"displayName": "Trade And Other Payables",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.TradeAndOtherPayables"
},
{
"displayName": "Opening Balance Equity",
"required": false,
"type": "String",
"value": "Equity.Equity.OpeningBalanceEquity"
},
{
"displayName": "Partners Equity",
"required": false,
"type": "String",
"value": "Equity.Equity.PartnersEquity"
},
{
"displayName": "Retained Earnings",
"required": false,
"type": "String",
"value": "Equity.Equity.RetainedEarnings"
},
{
"displayName": "Accumulated Adjustment",
"required": false,
"type": "String",
"value": "Equity.Equity.AccumulatedAdjustment"
},
{
"displayName": "Owners Equity",
"required": false,
"type": "String",
"value": "Equity.Equity.OwnersEquity"
},
{
"displayName": "Paid In Capital Or Surplus",
"required": false,
"type": "String",
"value": "Equity.Equity.PaidInCapitalOrSurplus"
},
{
"displayName": "Partner Contributions",
"required": false,
"type": "String",
"value": "Equity.Equity.PartnerContributions"
},
{
"displayName": "Partner Distributions",
"required": false,
"type": "String",
"value": "Equity.Equity.PartnerDistributions"
},
{
"displayName": "Preferred Stock",
"required": false,
"type": "String",
"value": "Equity.Equity.PreferredStock"
},
{
"displayName": "Common Stock",
"required": false,
"type": "String",
"value": "Equity.Equity.CommonStock"
},
{
"displayName": "Treasury Stock",
"required": false,
"type": "String",
"value": "Equity.Equity.TreasuryStock"
},
{
"displayName": "Estimated Taxes",
"required": false,
"type": "String",
"value": "Equity.Equity.EstimatedTaxes"
},
{
"displayName": "Healthcare",
"required": false,
"type": "String",
"value": "Equity.Equity.Healthcare"
},
{
"displayName": "Personal Income",
"required": false,
"type": "String",
"value": "Equity.Equity.PersonalIncome"
},
{
"displayName": "Personal Expense",
"required": false,
"type": "String",
"value": "Equity.Equity.PersonalExpense"
},
{
"displayName": "Accumulated Other Comprehensive Income",
"required": false,
"type": "String",
"value": "Equity.Equity.AccumulatedOtherComprehensiveIncome"
},
{
"displayName": "Called Up Share Capital",
"required": false,
"type": "String",
"value": "Equity.Equity.CalledUpShareCapital"
},
{
"displayName": "Capital Reserves",
"required": false,
"type": "String",
"value": "Equity.Equity.CapitalReserves"
},
{
"displayName": "Dividend Disbursed",
"required": false,
"type": "String",
"value": "Equity.Equity.DividendDisbursed"
},
{
"displayName": "Equity In Earnings Of Subsiduaries",
"required": false,
"type": "String",
"value": "Equity.Equity.EquityInEarningsOfSubsiduaries"
},
{
"displayName": "Investment Grants",
"required": false,
"type": "String",
"value": "Equity.Equity.InvestmentGrants"
},
{
"displayName": "Money Received Against Share Warrants",
"required": false,
"type": "String",
"value": "Equity.Equity.MoneyReceivedAgainstShareWarrants"
},
{
"displayName": "Other Free Reserves",
"required": false,
"type": "String",
"value": "Equity.Equity.OtherFreeReserves"
},
{
"displayName": "Share Application Money Pending Allotment",
"required": false,
"type": "String",
"value": "Equity.Equity.ShareApplicationMoneyPendingAllotment"
},
{
"displayName": "Share Capital",
"required": false,
"type": "String",
"value": "Equity.Equity.ShareCapital"
},
{
"displayName": "Funds",
"required": false,
"type": "String",
"value": "Equity.Equity.Funds"
}
],
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 100 characters",
"field": "Name"
}
]
}
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If included must have a length between 1 and 7 characters",
"field": "NominalCode"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Nominal Accounts are the categories a business uses to record transactions",
"displayName": "Nominal Account",
"properties": {
"currency": {
"description": "The currency of the account",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "When not specified company base currency will be used",
"field": "Currency"
}
],
"warnings": []
}
},
"fullyQualifiedCategory": {
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"displayName": "Fully Qualified Category",
"options": [
{
"displayName": "Cash On Hand",
"required": false,
"type": "String",
"value": "Asset.Bank.CashOnHand"
},
{
"displayName": "Checking",
"required": false,
"type": "String",
"value": "Asset.Bank.Checking"
},
{
"displayName": "Money Market",
"required": false,
"type": "String",
"value": "Asset.Bank.MoneyMarket"
},
{
"displayName": "Rents Held In Trust",
"required": false,
"type": "String",
"value": "Asset.Bank.RentsHeldInTrust"
},
{
"displayName": "Savings",
"required": false,
"type": "String",
"value": "Asset.Bank.Savings"
},
{
"displayName": "Trust Accounts",
"required": false,
"type": "String",
"value": "Asset.Bank.TrustAccounts"
},
{
"displayName": "Cash And Cash Equivalents",
"required": false,
"type": "String",
"value": "Asset.Bank.CashAndCashEquivalents"
},
{
"displayName": "Other Earmarked Bank Accounts",
"required": false,
"type": "String",
"value": "Asset.Bank.OtherEarmarkedBankAccounts"
},
{
"displayName": "Allowance For Bad Debts",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.AllowanceForBadDebts"
},
{
"displayName": "Development Costs",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.DevelopmentCosts"
},
{
"displayName": "Employee Cash Advances",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.EmployeeCashAdvances"
},
{
"displayName": "Other Current Assets",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.OtherCurrentAssets"
},
{
"displayName": "Inventory",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Inventory"
},
{
"displayName": "Investment Mortgage Real Estate Loans",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Investment_MortgageRealEstateLoans"
},
{
"displayName": "Investment Other",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Investment_Other"
},
{
"displayName": "Investment Tax Exempt Securities",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Investment_TaxExemptSecurities"
},
{
"displayName": "Investment US Government Obligations",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Investment_USGovernmentObligations"
},
{
"displayName": "Loans To Officers",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.LoansToOfficers"
},
{
"displayName": "Loans To Others",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.LoansToOthers"
},
{
"displayName": "Loans To Stockholders",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.LoansToStockholders"
},
{
"displayName": "Prepaid Expenses",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.PrepaidExpenses"
},
{
"displayName": "Retainage",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.Retainage"
},
{
"displayName": "Undeposited Funds",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.UndepositedFunds"
},
{
"displayName": "Assets Available For Sale",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.AssetsAvailableForSale"
},
{
"displayName": "Balance With Govt Authorities",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.BalWithGovtAuthorities"
},
{
"displayName": "Called Up Share Capital Not Paid",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.CalledUpShareCapitalNotPaid"
},
{
"displayName": "Expenditure Authorisations And Letters Of Credit",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit"
},
{
"displayName": "Global Tax Deferred",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.GlobalTaxDeferred"
},
{
"displayName": "Global Tax Refund",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.GlobalTaxRefund"
},
{
"displayName": "Internal Transfers",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.InternalTransfers"
},
{
"displayName": "Other Consumables",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.OtherConsumables"
},
{
"displayName": "Provisions Current Assets",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.ProvisionsCurrentAssets"
},
{
"displayName": "Short Term Investments In Related Parties",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties"
},
{
"displayName": "Short Term Loans And Advances To Related Parties",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties"
},
{
"displayName": "Trade And Other Receivables",
"required": false,
"type": "String",
"value": "Asset.Other Current Asset.TradeAndOtherReceivables"
},
{
"displayName": "Accumulated Depletion",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.AccumulatedDepletion"
},
{
"displayName": "Accumulated Depreciation",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.AccumulatedDepreciation"
},
{
"displayName": "Depletable Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.DepletableAssets"
},
{
"displayName": "Fixed Asset Computers",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetComputers"
},
{
"displayName": "Fixed Asset Copiers",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetCopiers"
},
{
"displayName": "Fixed Asset Furniture",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetFurniture"
},
{
"displayName": "Fixed Asset Phone",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetPhone"
},
{
"displayName": "Fixed Asset Photo Video",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetPhotoVideo"
},
{
"displayName": "Fixed Asset Software",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetSoftware"
},
{
"displayName": "Fixed Asset Other Tools Equipment",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FixedAssetOtherToolsEquipment"
},
{
"displayName": "Furniture And Fixtures",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.FurnitureAndFixtures"
},
{
"displayName": "Land",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.Land"
},
{
"displayName": "Leasehold Improvements",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.LeaseholdImprovements"
},
{
"displayName": "Other Fixed Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.OtherFixedAssets"
},
{
"displayName": "Accumulated Amortization",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.AccumulatedAmortization"
},
{
"displayName": "Buildings",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.Buildings"
},
{
"displayName": "Intangible Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.IntangibleAssets"
},
{
"displayName": "Machinery And Equipment",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.MachineryAndEquipment"
},
{
"displayName": "Vehicles",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.Vehicles"
},
{
"displayName": "Assets In Course Of Construction",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.AssetsInCourseOfConstruction"
},
{
"displayName": "Capital Wip",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.CapitalWip"
},
{
"displayName": "Cumulative Depreciation On Intangible Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets"
},
{
"displayName": "Intangible Assets Under Development",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.IntangibleAssetsUnderDevelopment"
},
{
"displayName": "Land Asset",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.LandAsset"
},
{
"displayName": "Non Current Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.NonCurrentAssets"
},
{
"displayName": "Participating Interests",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.ParticipatingInterests"
},
{
"displayName": "Provisions Fixed Assets",
"required": false,
"type": "String",
"value": "Asset.Fixed Asset.ProvisionsFixedAssets"
},
{
"displayName": "Lease Buyout",
"required": false,
"type": "String",
"value": "Asset.Other Asset.LeaseBuyout"
},
{
"displayName": "Other Long Term Assets",
"required": false,
"type": "String",
"value": "Asset.Other Asset.OtherLongTermAssets"
},
{
"displayName": "Security Deposits",
"required": false,
"type": "String",
"value": "Asset.Other Asset.SecurityDeposits"
},
{
"displayName": "Accumulated Amortization Of Other Assets",
"required": false,
"type": "String",
"value": "Asset.Other Asset.AccumulatedAmortizationOfOtherAssets"
},
{
"displayName": "Goodwill",
"required": false,
"type": "String",
"value": "Asset.Other Asset.Goodwill"
},
{
"displayName": "Licenses",
"required": false,
"type": "String",
"value": "Asset.Other Asset.Licenses"
},
{
"displayName": "Organizational Costs",
"required": false,
"type": "String",
"value": "Asset.Other Asset.OrganizationalCosts"
},
{
"displayName": "Assets Held For Sale",
"required": false,
"type": "String",
"value": "Asset.Other Asset.AssetsHeldForSale"
},
{
"displayName": "Available For Sale Financial Assets",
"required": false,
"type": "String",
"value": "Asset.Other Asset.AvailableForSaleFinancialAssets"
},
{
"displayName": "Deferred Tax",
"required": false,
"type": "String",
"value": "Asset.Other Asset.DeferredTax"
},
{
"displayName": "Investments",
"required": false,
"type": "String",
"value": "Asset.Other Asset.Investments"
},
{
"displayName": "Long Term Investments",
"required": false,
"type": "String",
"value": "Asset.Other Asset.LongTermInvestments"
},
{
"displayName": "Long Term Loans And Advances To Related Parties",
"required": false,
"type": "String",
"value": "Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties"
},
{
"displayName": "Other Intangible Assets",
"required": false,
"type": "String",
"value": "Asset.Other Asset.OtherIntangibleAssets"
},
{
"displayName": "Other Long Term Investments",
"required": false,
"type": "String",
"value": "Asset.Other Asset.OtherLongTermInvestments"
},
{
"displayName": "Other Long Term Loans And Advances",
"required": false,
"type": "String",
"value": "Asset.Other Asset.OtherLongTermLoansAndAdvances"
},
{
"displayName": "Prepayments And Accrued Income",
"required": false,
"type": "String",
"value": "Asset.Other Asset.PrepaymentsAndAccruedIncome"
},
{
"displayName": "Provisions Non-Current Assets",
"required": false,
"type": "String",
"value": "Asset.Other Asset.ProvisionsNonCurrentAssets"
},
{
"displayName": "Accounts Receivable",
"required": false,
"type": "String",
"value": "Asset.Accounts Receivable.AccountsReceivable"
},
{
"displayName": "Advertising/Promotional",
"required": false,
"type": "String",
"value": "Expense.Expense.AdvertisingPromotional"
},
{
"displayName": "Bad Debts",
"required": false,
"type": "String",
"value": "Expense.Expense.BadDebts"
},
{
"displayName": "Bank Charges",
"required": false,
"type": "String",
"value": "Expense.Expense.BankCharges"
},
{
"displayName": "Charitable Contributions",
"required": false,
"type": "String",
"value": "Expense.Expense.CharitableContributions"
},
{
"displayName": "Commissions And Fees",
"required": false,
"type": "String",
"value": "Expense.Expense.CommissionsAndFees"
},
{
"displayName": "Entertainment",
"required": false,
"type": "String",
"value": "Expense.Expense.Entertainment"
},
{
"displayName": "Entertainment Meals",
"required": false,
"type": "String",
"value": "Expense.Expense.EntertainmentMeals"
},
{
"displayName": "Equipment Rental",
"required": false,
"type": "String",
"value": "Expense.Expense.EquipmentRental"
},
{
"displayName": "Finance Costs",
"required": false,
"type": "String",
"value": "Expense.Expense.FinanceCosts"
},
{
"displayName": "Global Tax Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.GlobalTaxExpense"
},
{
"displayName": "Insurance",
"required": false,
"type": "String",
"value": "Expense.Expense.Insurance"
},
{
"displayName": "Interest Paid",
"required": false,
"type": "String",
"value": "Expense.Expense.InterestPaid"
},
{
"displayName": "Legal And Professional Fees",
"required": false,
"type": "String",
"value": "Expense.Expense.LegalProfessionalFees"
},
{
"displayName": "Office Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.OfficeExpenses"
},
{
"displayName": "Office/General Administrative Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.OfficeGeneralAdministrativeExpenses"
},
{
"displayName": "Other Business Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherBusinessExpenses"
},
{
"displayName": "Other Miscellaneous Service Cost",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherMiscellaneousServiceCost"
},
{
"displayName": "Promotional Meals",
"required": false,
"type": "String",
"value": "Expense.Expense.PromotionalMeals"
},
{
"displayName": "Rent Or Lease Of Buildings",
"required": false,
"type": "String",
"value": "Expense.Expense.RentOrLeaseOfBuildings"
},
{
"displayName": "Repair And Maintenance",
"required": false,
"type": "String",
"value": "Expense.Expense.RepairMaintenance"
},
{
"displayName": "Shipping, Freight And Delivery",
"required": false,
"type": "String",
"value": "Expense.Expense.ShippingFreightDelivery"
},
{
"displayName": "Supplies And Materials",
"required": false,
"type": "String",
"value": "Expense.Expense.SuppliesMaterials"
},
{
"displayName": "Travel",
"required": false,
"type": "String",
"value": "Expense.Expense.Travel"
},
{
"displayName": "Travel Meals",
"required": false,
"type": "String",
"value": "Expense.Expense.TravelMeals"
},
{
"displayName": "Utilities",
"required": false,
"type": "String",
"value": "Expense.Expense.Utilities"
},
{
"displayName": "Auto",
"required": false,
"type": "String",
"value": "Expense.Expense.Auto"
},
{
"displayName": "Cost Of Labor",
"required": false,
"type": "String",
"value": "Expense.Expense.CostOfLabor"
},
{
"displayName": "Dues And Subscriptions",
"required": false,
"type": "String",
"value": "Expense.Expense.DuesSubscriptions"
},
{
"displayName": "Payroll Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.PayrollExpenses"
},
{
"displayName": "Taxes Paid",
"required": false,
"type": "String",
"value": "Expense.Expense.TaxesPaid"
},
{
"displayName": "Unapplied Cash Bill Payment Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.UnappliedCashBillPaymentExpense"
},
{
"displayName": "Utilities",
"required": false,
"type": "String",
"value": "Expense.Expense.Utilities"
},
{
"displayName": "Amortization Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.AmortizationExpense"
},
{
"displayName": "Appropriations To Depreciation",
"required": false,
"type": "String",
"value": "Expense.Expense.AppropriationsToDepreciation"
},
{
"displayName": "Borrowing Cost",
"required": false,
"type": "String",
"value": "Expense.Expense.BorrowingCost"
},
{
"displayName": "Commissions And Fees",
"required": false,
"type": "String",
"value": "Expense.Expense.CommissionsAndFees"
},
{
"displayName": "Distribution Costs",
"required": false,
"type": "String",
"value": "Expense.Expense.DistributionCosts"
},
{
"displayName": "External Services",
"required": false,
"type": "String",
"value": "Expense.Expense.ExternalServices"
},
{
"displayName": "Extraordinary Charges",
"required": false,
"type": "String",
"value": "Expense.Expense.ExtraordinaryCharges"
},
{
"displayName": "Income Tax Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.IncomeTaxExpense"
},
{
"displayName": "Loss On Discontinued Operations Net Of Tax",
"required": false,
"type": "String",
"value": "Expense.Expense.LossOnDiscontinuedOperationsNetOfTax"
},
{
"displayName": "Management Compensation",
"required": false,
"type": "String",
"value": "Expense.Expense.ManagementCompensation"
},
{
"displayName": "Other Current Operating Charges",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherCurrentOperatingCharges"
},
{
"displayName": "Other External Services",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherExternalServices"
},
{
"displayName": "Other Rental Costs",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherRentalCosts"
},
{
"displayName": "Other Selling Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.OtherSellingExpenses"
},
{
"displayName": "Project Studies Surveys Assessments",
"required": false,
"type": "String",
"value": "Expense.Expense.ProjectStudiesSurveysAssessments"
},
{
"displayName": "Purchases Rebates",
"required": false,
"type": "String",
"value": "Expense.Expense.PurchasesRebates"
},
{
"displayName": "Shipping And Delivery Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.ShippingAndDeliveryExpense"
},
{
"displayName": "Staff Costs",
"required": false,
"type": "String",
"value": "Expense.Expense.StaffCosts"
},
{
"displayName": "Sundry",
"required": false,
"type": "String",
"value": "Expense.Expense.Sundry"
},
{
"displayName": "Travel Expenses General And Admin Expenses",
"required": false,
"type": "String",
"value": "Expense.Expense.TravelExpensesGeneralAndAdminExpenses"
},
{
"displayName": "Travel Expenses Selling Expense",
"required": false,
"type": "String",
"value": "Expense.Expense.TravelExpensesSellingExpense"
},
{
"displayName": "Depreciation",
"required": false,
"type": "String",
"value": "Expense.Other Expense.Depreciation"
},
{
"displayName": "Exchange Gain Or Loss",
"required": false,
"type": "String",
"value": "Expense.Other Expense.ExchangeGainOrLoss"
},
{
"displayName": "Other Miscellaneous Expense",
"required": false,
"type": "String",
"value": "Expense.Other Expense.OtherMiscellaneousExpense"
},
{
"displayName": "Penalties And Settlements",
"required": false,
"type": "String",
"value": "Expense.Other Expense.PenaltiesSettlements"
},
{
"displayName": "Amortization",
"required": false,
"type": "String",
"value": "Expense.Other Expense.Amortization"
},
{
"displayName": "Gas And Fuel",
"required": false,
"type": "String",
"value": "Expense.Other Expense.GasAndFuel"
},
{
"displayName": "Home Office",
"required": false,
"type": "String",
"value": "Expense.Other Expense.HomeOffice"
},
{
"displayName": "Home Owner Rental Insurance",
"required": false,
"type": "String",
"value": "Expense.Other Expense.HomeOwnerRentalInsurance"
},
{
"displayName": "Other Home Office Expenses",
"required": false,
"type": "String",
"value": "Expense.Other Expense.OtherHomeOfficeExpenses"
},
{
"displayName": "Mortgage Interest",
"required": false,
"type": "String",
"value": "Expense.Other Expense.MortgageInterest"
},
{
"displayName": "Rent And Lease",
"required": false,
"type": "String",
"value": "Expense.Other Expense.RentAndLease"
},
{
"displayName": "Repairs And Maintenance",
"required": false,
"type": "String",
"value": "Expense.Other Expense.RepairsAndMaintenance"
},
{
"displayName": "Parking And Tolls",
"required": false,
"type": "String",
"value": "Expense.Other Expense.ParkingAndTolls"
},
{
"displayName": "Vehicle",
"required": false,
"type": "String",
"value": "Expense.Other Expense.Vehicle"
},
{
"displayName": "Vehicle Insurance",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleInsurance"
},
{
"displayName": "Vehicle Lease",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleLease"
},
{
"displayName": "Vehicle Loan Interest",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleLoanInterest"
},
{
"displayName": "Vehicle Loan",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleLoan"
},
{
"displayName": "Vehicle Registration",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleRegistration"
},
{
"displayName": "Vehicle Repairs",
"required": false,
"type": "String",
"value": "Expense.Other Expense.VehicleRepairs"
},
{
"displayName": "Other Vehicle Expenses",
"required": false,
"type": "String",
"value": "Expense.Other Expense.OtherVehicleExpenses"
},
{
"displayName": "Utilities",
"required": false,
"type": "String",
"value": "Expense.Other Expense.Utilities"
},
{
"displayName": "Wash And Road Services",
"required": false,
"type": "String",
"value": "Expense.Other Expense.WashAndRoadServices"
},
{
"displayName": "Deferred Tax Expense",
"required": false,
"type": "String",
"value": "Expense.Other Expense.DeferredTaxExpense"
},
{
"displayName": "Depletion",
"required": false,
"type": "String",
"value": "Expense.Other Expense.Depletion"
},
{
"displayName": "Exceptional Items",
"required": false,
"type": "String",
"value": "Expense.Other Expense.ExceptionalItems"
},
{
"displayName": "Extraordinary Items",
"required": false,
"type": "String",
"value": "Expense.Other Expense.ExtraordinaryItems"
},
{
"displayName": "Income Tax Other Expense",
"required": false,
"type": "String",
"value": "Expense.Other Expense.IncomeTaxOtherExpense"
},
{
"displayName": "Mat Credit",
"required": false,
"type": "String",
"value": "Expense.Other Expense.MatCredit"
},
{
"displayName": "Prior Period Items",
"required": false,
"type": "String",
"value": "Expense.Other Expense.PriorPeriodItems"
},
{
"displayName": "Tax Roundoff Gain Or Loss",
"required": false,
"type": "String",
"value": "Expense.Other Expense.TaxRoundoffGainOrLoss"
},
{
"displayName": "Equipment Rental - COS",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.EquipmentRentalCos"
},
{
"displayName": "Other Costs Of Sales - COS",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.OtherCostsOfServiceCos"
},
{
"displayName": "Shipping, Freight And Delivery - COS",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.ShippingFreightDeliveryCos"
},
{
"displayName": "Supplies And Materials - COS",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.SuppliesMaterialsCogs"
},
{
"displayName": "Cost Of Labor - COS",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.CostOfLaborCos"
},
{
"displayName": "Cost Of Sales",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.CostOfSales"
},
{
"displayName": "Freight And Delivery Cost",
"required": false,
"type": "String",
"value": "Expense.Cost of Goods Sold.FreightAndDeliveryCost"
},
{
"displayName": "Non Profit Income",
"required": false,
"type": "String",
"value": "Income.Income.NonProfitIncome"
},
{
"displayName": "Other Primary Income",
"required": false,
"type": "String",
"value": "Income.Income.OtherPrimaryIncome"
},
{
"displayName": "Sales Of ProductIncome",
"required": false,
"type": "String",
"value": "Income.Income.SalesOfProductIncome"
},
{
"displayName": "Service Fee Income",
"required": false,
"type": "String",
"value": "Income.Income.ServiceFeeIncome"
},
{
"displayName": "Discounts Refunds Given",
"required": false,
"type": "String",
"value": "Income.Income.DiscountsRefundsGiven"
},
{
"displayName": "Unapplied Cash Payment Income",
"required": false,
"type": "String",
"value": "Income.Income.UnappliedCashPaymentIncome"
},
{
"displayName": "Cash Receipt Income",
"required": false,
"type": "String",
"value": "Income.Income.CashReceiptIncome"
},
{
"displayName": "Operating Grants",
"required": false,
"type": "String",
"value": "Income.Income.OperatingGrants"
},
{
"displayName": "Other Current Operating Income",
"required": false,
"type": "String",
"value": "Income.Income.OtherCurrentOperatingIncome"
},
{
"displayName": "Own Work Capitalized",
"required": false,
"type": "String",
"value": "Income.Income.OwnWorkCapitalized"
},
{
"displayName": "Revenue General",
"required": false,
"type": "String",
"value": "Income.Income.RevenueGeneral"
},
{
"displayName": "Sales Retail",
"required": false,
"type": "String",
"value": "Income.Income.SalesRetail"
},
{
"displayName": "Sales Wholesale",
"required": false,
"type": "String",
"value": "Income.Income.SalesWholesale"
},
{
"displayName": "Savings By Tax Scheme",
"required": false,
"type": "String",
"value": "Income.Income.SavingsByTaxScheme"
},
{
"displayName": "Dividend Income",
"required": false,
"type": "String",
"value": "Income.Other Income.DividendIncome"
},
{
"displayName": "Interest Earned",
"required": false,
"type": "String",
"value": "Income.Other Income.InterestEarned"
},
{
"displayName": "Other Investment Income",
"required": false,
"type": "String",
"value": "Income.Other Income.OtherInvestmentIncome"
},
{
"displayName": "Other Miscellaneous Income",
"required": false,
"type": "String",
"value": "Income.Other Income.OtherMiscellaneousIncome"
},
{
"displayName": "Tax Exempt Interest",
"required": false,
"type": "String",
"value": "Income.Other Income.TaxExemptInterest"
},
{
"displayName": "Gain Loss On Sale Of Fixed Assets",
"required": false,
"type": "String",
"value": "Income.Other Income.GainLossOnSaleOfFixedAssets"
},
{
"displayName": "Gain Loss On Sale Of Investments",
"required": false,
"type": "String",
"value": "Income.Other Income.GainLossOnSaleOfInvestments"
},
{
"displayName": "Loss On Disposal Of Assets",
"required": false,
"type": "String",
"value": "Income.Other Income.LossOnDisposalOfAssets"
},
{
"displayName": "Other Operating Income",
"required": false,
"type": "String",
"value": "Income.Other Income.OtherOperatingIncome"
},
{
"displayName": "Unrealised Loss On Securities Net Of Tax",
"required": false,
"type": "String",
"value": "Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax"
},
{
"displayName": "Accounts Payable",
"required": false,
"type": "String",
"value": "Liability.Accounts Payable.AccountsPayable"
},
{
"displayName": "Outstanding Dues Micro Small Enterprise",
"required": false,
"type": "String",
"value": "Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise"
},
{
"displayName": "Outstanding Dues Other Than Micro Small Enterprise",
"required": false,
"type": "String",
"value": "Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise"
},
{
"displayName": "Credit Card",
"required": false,
"type": "String",
"value": "Liability.Credit Card.CreditCard"
},
{
"displayName": "Notes Payable",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.NotesPayable"
},
{
"displayName": "Other Long Term Liabilities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.OtherLongTermLiabilities"
},
{
"displayName": "Shareholder Notes Payable",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.ShareholderNotesPayable"
},
{
"displayName": "Accruals And Deferred Income",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.AccrualsAndDeferredIncome"
},
{
"displayName": "Accrued Long Lerm Liabilities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.AccruedLongLermLiabilities"
},
{
"displayName": "Accrued Vacation Payable",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.AccruedVacationPayable"
},
{
"displayName": "Bank Loans",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.BankLoans"
},
{
"displayName": "Debts Related To Participating Interests",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.DebtsRelatedToParticipatingInterests"
},
{
"displayName": "Deferred Tax Liabilities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.DeferredTaxLiabilities"
},
{
"displayName": "Government And Other Public Authorities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities"
},
{
"displayName": "Group And Associates",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.GroupAndAssociates"
},
{
"displayName": "Liabilities Related To Assets Held For Sale",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale"
},
{
"displayName": "Long Term Borrowings",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.LongTermBorrowings"
},
{
"displayName": "Long Term Debit",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.LongTermDebit"
},
{
"displayName": "Long Term Employee Benefit Obligations",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.LongTermEmployeeBenefitObligations"
},
{
"displayName": "Obligations Under Finance Leases",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.ObligationsUnderFinanceLeases"
},
{
"displayName": "Other Long Term Provisions",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.OtherLongTermProvisions"
},
{
"displayName": "Provision For Liabilities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.ProvisionForLiabilities"
},
{
"displayName": "Provisions Non Current Liabilities",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.ProvisionsNonCurrentLiabilities"
},
{
"displayName": "Staff And Related Long Term Liability Accounts",
"required": false,
"type": "String",
"value": "Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts"
},
{
"displayName": "Direct Deposit Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.DirectDepositPayable"
},
{
"displayName": "Line Of Credit",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.LineOfCredit"
},
{
"displayName": "Loan Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.LoanPayable"
},
{
"displayName": "Global Tax Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.GlobalTaxPayable"
},
{
"displayName": "Global Tax Suspense",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.GlobalTaxSuspense"
},
{
"displayName": "Other Current Liabilities",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.OtherCurrentLiabilities"
},
{
"displayName": "Payroll Clearing",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.PayrollClearing"
},
{
"displayName": "Payroll Tax Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.PayrollTaxPayable"
},
{
"displayName": "Prepaid Expenses Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.PrepaidExpensesPayable"
},
{
"displayName": "Rents In Trust Liability",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.RentsInTrustLiability"
},
{
"displayName": "Trust Accounts Liabilities",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.TrustAccountsLiabilities"
},
{
"displayName": "Federal Income Tax Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.FederalIncomeTaxPayable"
},
{
"displayName": "Insurance Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.InsurancePayable"
},
{
"displayName": "Sales Tax Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.SalesTaxPayable"
},
{
"displayName": "State Local Income Tax Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.StateLocalIncomeTaxPayable"
},
{
"displayName": "Accrued Liabilities",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.AccruedLiabilities"
},
{
"displayName": "Current Liabilities",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.CurrentLiabilities"
},
{
"displayName": "Current Portion EmployeeBenefits Obligations",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations"
},
{
"displayName": "Current Portion Of Obligations Under Finance Leases",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases"
},
{
"displayName": "Current Tax Liability",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.CurrentTaxLiability"
},
{
"displayName": "Dividends Payable",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.DividendsPayable"
},
{
"displayName": "Duties And Taxes",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.DutiesAndTaxes"
},
{
"displayName": "Interest Payables",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.InterestPayables"
},
{
"displayName": "Provision For Warranty Obligations",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.ProvisionForWarrantyObligations"
},
{
"displayName": "Provisions Current Liabilities",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.ProvisionsCurrentLiabilities"
},
{
"displayName": "Short Term Borrowings",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.ShortTermBorrowings"
},
{
"displayName": "Social Security Agencies",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.SocialSecurityAgencies"
},
{
"displayName": "Staff And Related Liability Accounts",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts"
},
{
"displayName": "Sundry Debtors And Creditors",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.SundryDebtorsAndCreditors"
},
{
"displayName": "Trade And Other Payables",
"required": false,
"type": "String",
"value": "Liability.Other Current Liability.TradeAndOtherPayables"
},
{
"displayName": "Opening Balance Equity",
"required": false,
"type": "String",
"value": "Equity.Equity.OpeningBalanceEquity"
},
{
"displayName": "Partners Equity",
"required": false,
"type": "String",
"value": "Equity.Equity.PartnersEquity"
},
{
"displayName": "Retained Earnings",
"required": false,
"type": "String",
"value": "Equity.Equity.RetainedEarnings"
},
{
"displayName": "Accumulated Adjustment",
"required": false,
"type": "String",
"value": "Equity.Equity.AccumulatedAdjustment"
},
{
"displayName": "Owners Equity",
"required": false,
"type": "String",
"value": "Equity.Equity.OwnersEquity"
},
{
"displayName": "Paid In Capital Or Surplus",
"required": false,
"type": "String",
"value": "Equity.Equity.PaidInCapitalOrSurplus"
},
{
"displayName": "Partner Contributions",
"required": false,
"type": "String",
"value": "Equity.Equity.PartnerContributions"
},
{
"displayName": "Partner Distributions",
"required": false,
"type": "String",
"value": "Equity.Equity.PartnerDistributions"
},
{
"displayName": "Preferred Stock",
"required": false,
"type": "String",
"value": "Equity.Equity.PreferredStock"
},
{
"displayName": "Common Stock",
"required": false,
"type": "String",
"value": "Equity.Equity.CommonStock"
},
{
"displayName": "Treasury Stock",
"required": false,
"type": "String",
"value": "Equity.Equity.TreasuryStock"
},
{
"displayName": "Estimated Taxes",
"required": false,
"type": "String",
"value": "Equity.Equity.EstimatedTaxes"
},
{
"displayName": "Healthcare",
"required": false,
"type": "String",
"value": "Equity.Equity.Healthcare"
},
{
"displayName": "Personal Income",
"required": false,
"type": "String",
"value": "Equity.Equity.PersonalIncome"
},
{
"displayName": "Personal Expense",
"required": false,
"type": "String",
"value": "Equity.Equity.PersonalExpense"
},
{
"displayName": "Accumulated Other Comprehensive Income",
"required": false,
"type": "String",
"value": "Equity.Equity.AccumulatedOtherComprehensiveIncome"
},
{
"displayName": "Called Up Share Capital",
"required": false,
"type": "String",
"value": "Equity.Equity.CalledUpShareCapital"
},
{
"displayName": "Capital Reserves",
"required": false,
"type": "String",
"value": "Equity.Equity.CapitalReserves"
},
{
"displayName": "Dividend Disbursed",
"required": false,
"type": "String",
"value": "Equity.Equity.DividendDisbursed"
},
{
"displayName": "Equity In Earnings Of Subsiduaries",
"required": false,
"type": "String",
"value": "Equity.Equity.EquityInEarningsOfSubsiduaries"
},
{
"displayName": "Investment Grants",
"required": false,
"type": "String",
"value": "Equity.Equity.InvestmentGrants"
},
{
"displayName": "Money Received Against Share Warrants",
"required": false,
"type": "String",
"value": "Equity.Equity.MoneyReceivedAgainstShareWarrants"
},
{
"displayName": "Other Free Reserves",
"required": false,
"type": "String",
"value": "Equity.Equity.OtherFreeReserves"
},
{
"displayName": "Share Application Money Pending Allotment",
"required": false,
"type": "String",
"value": "Equity.Equity.ShareApplicationMoneyPendingAllotment"
},
{
"displayName": "Share Capital",
"required": false,
"type": "String",
"value": "Equity.Equity.ShareCapital"
},
{
"displayName": "Funds",
"required": false,
"type": "String",
"value": "Equity.Equity.Funds"
}
],
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 100 characters",
"field": "Name"
}
]
}
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If included must have a length between 1 and 7 characters",
"field": "NominalCode"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Nominal Accounts are the categories a business uses to record transactions",
"displayName": "Nominal Account",
"properties": {
"fullyQualifiedCategory": {
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"displayName": "Fully Qualified Category",
"options": [
{
"displayName": "Sales",
"required": false,
"type": "String",
"value": "SALES"
},
{
"displayName": "Other Income",
"required": false,
"type": "String",
"value": "OTHER_INCOME"
},
{
"displayName": "Direct Expenses",
"required": false,
"type": "String",
"value": "DIRECT_EXPENSES"
},
{
"displayName": "Overheads",
"required": false,
"type": "String",
"value": "OVERHEADS"
},
{
"displayName": "Depreciation",
"required": false,
"type": "String",
"value": "DEPRECIATION"
},
{
"displayName": "Current Assets",
"required": false,
"type": "String",
"value": "CURRENT_ASSETS"
},
{
"displayName": "Fixed Assets",
"required": false,
"type": "String",
"value": "FIXED_ASSETS"
},
{
"displayName": "Future Assets",
"required": false,
"type": "String",
"value": "FUTURE_ASSETS"
},
{
"displayName": "Bank",
"required": false,
"type": "String",
"value": "BANK"
},
{
"displayName": "Current Liability",
"required": false,
"type": "String",
"value": "CURRENT_LIABILITY"
},
{
"displayName": "Future Liability",
"required": false,
"type": "String",
"value": "FUTURE_LIABILITY"
},
{
"displayName": "Equity",
"required": false,
"type": "String",
"value": "EQUITY"
},
{
"displayName": "Credit Card / Loan",
"required": false,
"type": "String",
"value": "LINE_OF_CREDIT"
}
],
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Should not be longer than 200 characters.",
"field": "Name"
}
],
"warnings": []
}
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Should be a number between 1 and 99999999.",
"field": "NominalCode"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Nominal Accounts are the categories a business uses to record transactions",
"displayName": "Nominal Account",
"properties": {
"fullyQualifiedCategory": {
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"displayName": "Fully Qualified Category",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Any category that is part of the hierarchy of one of: 'Assets', 'Equity', 'Liabilities', 'Total Expenses' and 'Total Income' is permitted.",
"field": "FullyQualifiedCategory"
}
],
"warnings": []
}
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be unique within the entity.",
"field": "NominalCode"
},
{
"details": "Must be at most 24 characters in length, although restrictions may vary between entities.",
"field": "NominalCode"
}
]
}
},
"status": {
"description": "The status of the account",
"displayName": "Account Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"type": {
"description": "The type, or base category, of the account",
"displayName": "Account Type",
"options": [
{
"displayName": "Asset",
"required": false,
"type": "String",
"value": "Asset"
},
{
"displayName": "Equity",
"required": false,
"type": "String",
"value": "Equity"
},
{
"displayName": "Expense",
"required": false,
"type": "String",
"value": "Expense"
},
{
"displayName": "Income",
"required": false,
"type": "String",
"value": "Income"
},
{
"displayName": "Liability",
"required": false,
"type": "String",
"value": "Liability"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Nominal Accounts are the categories a business uses to record transactions",
"displayName": "Nominal Account",
"properties": {
"currency": {
"description": "The currency of the account",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currentBalance": {
"description": "The current balance in the account",
"displayName": "Current Balance",
"required": true,
"type": "Number"
},
"description": {
"description": "Description of the account",
"displayName": "Description",
"required": true,
"type": "String"
},
"fullyQualifiedCategory": {
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"displayName": "Fully Qualified Category",
"required": true,
"type": "String"
},
"fullyQualifiedName": {
"description": "The full name of the account e.g. Liability.Current.VAT or Income.Revenue.Sales",
"displayName": "Fully Qualified Name",
"required": true,
"type": "String"
},
"isBankAccount": {
"description": "Confirms whether the nominal account represents a bank account or not",
"displayName": "Is Bank Account?",
"required": true,
"type": "Boolean"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": true,
"type": "String"
},
"status": {
"description": "The status of the account",
"displayName": "Account Status",
"required": true,
"type": "String"
},
"type": {
"description": "The type, or base category, of the account",
"displayName": "Account Type",
"required": true,
"type": "String"
},
"validDatatypeLinks": {
"description": "Describes which fields on other data types are valid links to this account in the originating system",
"displayName": "Valid Datatype Links",
"properties": {
"links": {
"description": "A collection of absolute names of fields from other data types, e.g. Invoice.LineItems.AccountRef.Id",
"displayName": "Links",
"required": true,
"type": "Array"
},
"property": {
"description": "The field on the source data type that other data types can link to",
"displayName": "Property",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Nominal Accounts are the categories a business uses to record transactions",
"displayName": "Nominal Account",
"properties": {
"description": {
"description": "Description for the nominal account.",
"displayName": "Description",
"required": false,
"type": "String"
},
"fullyQualifiedCategory": {
"description": "Account type and category for nominal account.",
"displayName": "Fully Qualified Category",
"options": [
{
"displayName": "Current Asset",
"required": false,
"type": "String",
"value": "Asset.Current"
},
{
"displayName": "Fixed Asset",
"required": false,
"type": "String",
"value": "Asset.Fixed"
},
{
"displayName": "Inventory",
"required": false,
"type": "String",
"value": "Asset.Inventory"
},
{
"displayName": "Non-current Asset",
"required": false,
"type": "String",
"value": "Asset.NonCurrent"
},
{
"displayName": "Prepayment",
"required": false,
"type": "String",
"value": "Asset.Prepayment"
},
{
"displayName": "Direct Costs",
"required": false,
"type": "String",
"value": "Expense.DirectCosts"
},
{
"displayName": "Expense",
"required": false,
"type": "String",
"value": "Expense.Expense"
},
{
"displayName": "Overhead",
"required": false,
"type": "String",
"value": "Expense.Overhead"
},
{
"displayName": "Superannuation",
"required": false,
"type": "String",
"value": "Expense.Superannuation"
},
{
"displayName": "Wages",
"required": false,
"type": "String",
"value": "Expense.Wages"
},
{
"displayName": "Sales",
"required": false,
"type": "String",
"value": "Income.Sales"
},
{
"displayName": "Revenue",
"required": false,
"type": "String",
"value": "Income.Revenue"
},
{
"displayName": "Other Income",
"required": false,
"type": "String",
"value": "Income.Other"
},
{
"displayName": "Current Liability",
"required": false,
"type": "String",
"value": "Liability.Current"
},
{
"displayName": "Depreciation",
"required": false,
"type": "String",
"value": "Liability.Depreciation"
},
{
"displayName": "Liability",
"required": false,
"type": "String",
"value": "Liability.Liability"
},
{
"displayName": "Non Current Liability",
"required": false,
"type": "String",
"value": "Liability.NonCurrent"
},
{
"displayName": "Pay As You Go Liability",
"required": false,
"type": "String",
"value": "Liability.PayAsYouGo"
},
{
"displayName": "Superannuation Liability",
"required": false,
"type": "String",
"value": "Liability.Superannuation"
},
{
"displayName": "Wages Payable Liability",
"required": false,
"type": "String",
"value": "Liability.WagesPayable"
},
{
"displayName": "Equity",
"required": false,
"type": "String",
"value": "Equity.Equity"
}
],
"required": true,
"type": "String"
},
"name": {
"description": "Name of account as it appears in the chart of accounts or general ledger.",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Payments are enabled to this account if the name ends in .PaymentsEnabled.",
"field": "Name"
}
],
"warnings": []
}
},
"nominalCode": {
"description": "Identifier for the nominal account.",
"displayName": "Nominal Code",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 10 characters.",
"field": "NominalCode"
}
]
}
}
},
"required": true,
"type": "Object"
}
GET
List accounts
{{baseUrl}}/companies/:companyId/data/accounts
QUERY PARAMS
page
companyId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/accounts?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/accounts" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/accounts?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/accounts?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/accounts?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/accounts?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/accounts?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/accounts?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/accounts?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/accounts?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/accounts?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/accounts?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/accounts',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/accounts?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/accounts?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/accounts?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/accounts?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/accounts',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/accounts');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/accounts',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/accounts?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/accounts?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/accounts?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/accounts?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/accounts?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/accounts');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/accounts');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/accounts?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/accounts?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/accounts?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/accounts"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/accounts"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/accounts?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/accounts') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/accounts";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/accounts?page='http GET '{{baseUrl}}/companies/:companyId/data/accounts?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/accounts?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/accounts?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create bank transactions
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions
QUERY PARAMS
companyId
connectionId
BODY json
{
"accountId": "",
"transactions": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions" {:content-type :json
:form-params {:accountId ""
:transactions ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions"),
Content = new StringContent("{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions"
payload := strings.NewReader("{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 43
{
"accountId": "",
"transactions": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions")
.setHeader("content-type", "application/json")
.setBody("{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions")
.header("content-type", "application/json")
.body("{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}")
.asString(); const data = JSON.stringify({
accountId: '',
transactions: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions',
headers: {'content-type': 'application/json'},
data: {accountId: '', transactions: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"accountId":"","transactions":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "accountId": "",\n "transactions": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({accountId: '', transactions: ''}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions',
headers: {'content-type': 'application/json'},
body: {accountId: '', transactions: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
accountId: '',
transactions: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions',
headers: {'content-type': 'application/json'},
data: {accountId: '', transactions: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"accountId":"","transactions":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"accountId": @"",
@"transactions": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions",
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([
'accountId' => '',
'transactions' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions', [
'body' => '{
"accountId": "",
"transactions": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'accountId' => '',
'transactions' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'accountId' => '',
'transactions' => ''
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"accountId": "",
"transactions": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"accountId": "",
"transactions": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions"
payload = {
"accountId": "",
"transactions": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions"
payload <- "{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions') do |req|
req.body = "{\n \"accountId\": \"\",\n \"transactions\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions";
let payload = json!({
"accountId": "",
"transactions": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions \
--header 'content-type: application/json' \
--data '{
"accountId": "",
"transactions": ""
}'echo '{
"accountId": "",
"transactions": ""
}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "accountId": "",\n "transactions": ""\n}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactionsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"accountId": "",
"transactions": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:accountId/bankTransactions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List all bank transactions
{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/bankAccounts/:accountId/transactions?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/bankAccounts/:accountId/transactions?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/bankAccounts/:accountId/transactions?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/bankAccounts/:accountId/transactions') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page='http GET '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId/transactions?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List bank transactions for bank account
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions
QUERY PARAMS
page
companyId
connectionId
accountId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page='http GET '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId/bankTransactions?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List push options for bank account bank transactions
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions
QUERY PARAMS
companyId
connectionId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactionshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactionswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactionsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts/:accountId/bankTransactions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create bank account
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccountsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get bank account (GET)
{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/bankAccounts/:accountId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/bankAccounts/:accountId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/bankAccounts/:accountId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/bankAccounts/:accountId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/bankAccounts/:accountIdhttp GET {{baseUrl}}/companies/:companyId/data/bankAccounts/:accountIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/bankAccounts/:accountIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/bankAccounts/:accountId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get bank account
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountIdhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts/:accountId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create-update bank account model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/bankAccounts HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/bankAccounts',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/bankAccounts")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/bankAccounts') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccountshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccountswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccountsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bankAccounts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An account that bank transactions may be recorded against",
"displayName": "Bank Account",
"properties": {
"accountName": {
"description": "The name of the bank account in the originating system",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Needs to be of the format '{No.}-{Name}'",
"field": "AccountName"
}
],
"warnings": []
}
},
"accountNumber": {
"description": "The account number for the bank account",
"displayName": "Account Number",
"required": false,
"type": "String"
},
"currency": {
"description": "The currency of the bank account",
"displayName": "Currency",
"required": true,
"type": "String"
},
"iBan": {
"description": "The international bank account number of the account. Often used when making or receiving international payments",
"displayName": "IBAN",
"required": false,
"type": "String"
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Bank Account Posting Group with Nominal Account must exist",
"field": "NominalCode"
}
],
"warnings": []
}
},
"overdraftLimit": {
"description": "The pre-arranged overdraft limit of the account",
"displayName": "Overdraft Limit",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Default value is 0",
"field": "OverdraftLimit"
}
],
"warnings": []
}
},
"sortCode": {
"description": "The sort code for the bank account",
"displayName": "Sort Code",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must have a length between 0 and 20 characters",
"field": "SortCode"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An account that bank transactions may be recorded against",
"displayName": "Bank Account",
"properties": {
"accountName": {
"description": "The name of the bank account in the originating system",
"displayName": "Name",
"required": true,
"type": "String"
},
"accountNumber": {
"description": "The account number for the bank account",
"displayName": "Account Number",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not exceed the maximum length of 14 characters if the specified currency is GBP.",
"field": "AccountNumber"
}
]
}
},
"currency": {
"description": "The currency of the bank account",
"displayName": "Currency",
"required": false,
"type": "String"
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": false,
"type": "String"
},
"sortCode": {
"description": "The sort code for the bank account",
"displayName": "Sort Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be 6 characters long if the specified currency is GBP.",
"field": "SortCode"
},
{
"details": "Must be provided if the specified currency is GBP.",
"field": "SortCode"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An account that bank transactions may be recorded against",
"displayName": "Bank Account",
"properties": {
"accountName": {
"description": "The name of the bank account in the originating system",
"displayName": "Name",
"required": true,
"type": "String"
},
"accountNumber": {
"description": "The account number for the bank account",
"displayName": "Account Number",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not exceed the maximum length of 14 characters if the specified currency is GBP.",
"field": "AccountNumber"
}
]
}
},
"currency": {
"description": "The currency of the bank account",
"displayName": "Currency",
"required": false,
"type": "String"
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": false,
"type": "String"
},
"sortCode": {
"description": "The sort code for the bank account",
"displayName": "Sort Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be 6 characters long if the specified currency is GBP.",
"field": "SortCode"
},
{
"details": "Must be provided if the specified currency is GBP.",
"field": "SortCode"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An account that bank transactions may be recorded against",
"displayName": "Bank Account",
"properties": {
"accountName": {
"description": "The name of the bank account in the originating system",
"displayName": "Name",
"required": true,
"type": "String"
},
"accountNumber": {
"description": "The account number for the bank account",
"displayName": "Account Number",
"required": false,
"type": "String"
},
"balance": {
"description": "The balance of the bank account",
"displayName": "Balance",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "The opening balance, in the account currency",
"field": "Balance"
}
],
"warnings": []
}
},
"currency": {
"description": "The currency of the bank account",
"displayName": "Currency",
"options": [
{
"displayName": "AED",
"required": false,
"type": "String",
"value": "AED"
},
{
"displayName": "AMD",
"required": false,
"type": "String",
"value": "AMD"
},
{
"displayName": "AOA",
"required": false,
"type": "String",
"value": "AOA"
},
{
"displayName": "ARS",
"required": false,
"type": "String",
"value": "ARS"
},
{
"displayName": "AUD",
"required": false,
"type": "String",
"value": "AUD"
},
{
"displayName": "AWG",
"required": false,
"type": "String",
"value": "AWG"
},
{
"displayName": "AZN",
"required": false,
"type": "String",
"value": "AZN"
},
{
"displayName": "BBD",
"required": false,
"type": "String",
"value": "BBD"
},
{
"displayName": "BDT",
"required": false,
"type": "String",
"value": "BDT"
},
{
"displayName": "BGN",
"required": false,
"type": "String",
"value": "BGN"
},
{
"displayName": "BRL",
"required": false,
"type": "String",
"value": "BRL"
},
{
"displayName": "BWP",
"required": false,
"type": "String",
"value": "BWP"
},
{
"displayName": "CAD",
"required": false,
"type": "String",
"value": "CAD"
},
{
"displayName": "CHF",
"required": false,
"type": "String",
"value": "CHF"
},
{
"displayName": "CLP",
"required": false,
"type": "String",
"value": "CLP"
},
{
"displayName": "CNY",
"required": false,
"type": "String",
"value": "CNY"
},
{
"displayName": "COP",
"required": false,
"type": "String",
"value": "COP"
},
{
"displayName": "CRC",
"required": false,
"type": "String",
"value": "CRC"
},
{
"displayName": "CUC",
"required": false,
"type": "String",
"value": "CUC"
},
{
"displayName": "CUP",
"required": false,
"type": "String",
"value": "CUP"
},
{
"displayName": "CZK",
"required": false,
"type": "String",
"value": "CZK"
},
{
"displayName": "DKK",
"required": false,
"type": "String",
"value": "DKK"
},
{
"displayName": "DOP",
"required": false,
"type": "String",
"value": "DOP"
},
{
"displayName": "EGP",
"required": false,
"type": "String",
"value": "EGP"
},
{
"displayName": "EUR",
"required": false,
"type": "String",
"value": "EUR"
},
{
"displayName": "FJD",
"required": false,
"type": "String",
"value": "FJD"
},
{
"displayName": "GBP",
"required": false,
"type": "String",
"value": "GBP"
},
{
"displayName": "GEL",
"required": false,
"type": "String",
"value": "GEL"
},
{
"displayName": "GHS",
"required": false,
"type": "String",
"value": "GHS"
},
{
"displayName": "GTQ",
"required": false,
"type": "String",
"value": "GTQ"
},
{
"displayName": "GYD",
"required": false,
"type": "String",
"value": "GYD"
},
{
"displayName": "HKD",
"required": false,
"type": "String",
"value": "HKD"
},
{
"displayName": "HNL",
"required": false,
"type": "String",
"value": "HNL"
},
{
"displayName": "HRK",
"required": false,
"type": "String",
"value": "HRK"
},
{
"displayName": "HUF",
"required": false,
"type": "String",
"value": "HUF"
},
{
"displayName": "IDR",
"required": false,
"type": "String",
"value": "IDR"
},
{
"displayName": "ILS",
"required": false,
"type": "String",
"value": "ILS"
},
{
"displayName": "INR",
"required": false,
"type": "String",
"value": "INR"
},
{
"displayName": "ISK",
"required": false,
"type": "String",
"value": "ISK"
},
{
"displayName": "JMD",
"required": false,
"type": "String",
"value": "JMD"
},
{
"displayName": "JPY",
"required": false,
"type": "String",
"value": "JPY"
},
{
"displayName": "KES",
"required": false,
"type": "String",
"value": "KES"
},
{
"displayName": "KRW",
"required": false,
"type": "String",
"value": "KRW"
},
{
"displayName": "KWD",
"required": false,
"type": "String",
"value": "KWD"
},
{
"displayName": "KYD",
"required": false,
"type": "String",
"value": "KYD"
},
{
"displayName": "KZT",
"required": false,
"type": "String",
"value": "KZT"
},
{
"displayName": "LAK",
"required": false,
"type": "String",
"value": "LAK"
},
{
"displayName": "LBP",
"required": false,
"type": "String",
"value": "LBP"
},
{
"displayName": "LKR",
"required": false,
"type": "String",
"value": "LKR"
},
{
"displayName": "LTL",
"required": false,
"type": "String",
"value": "LTL"
},
{
"displayName": "LVL",
"required": false,
"type": "String",
"value": "LVL"
},
{
"displayName": "MAD",
"required": false,
"type": "String",
"value": "MAD"
},
{
"displayName": "MDL",
"required": false,
"type": "String",
"value": "MDL"
},
{
"displayName": "MGA",
"required": false,
"type": "String",
"value": "MGA"
},
{
"displayName": "MUR",
"required": false,
"type": "String",
"value": "MUR"
},
{
"displayName": "MVR",
"required": false,
"type": "String",
"value": "MVR"
},
{
"displayName": "MWK",
"required": false,
"type": "String",
"value": "MWK"
},
{
"displayName": "MXN",
"required": false,
"type": "String",
"value": "MXN"
},
{
"displayName": "MYR",
"required": false,
"type": "String",
"value": "MYR"
},
{
"displayName": "MZN",
"required": false,
"type": "String",
"value": "MZN"
},
{
"displayName": "NAD",
"required": false,
"type": "String",
"value": "NAD"
},
{
"displayName": "NGN",
"required": false,
"type": "String",
"value": "NGN"
},
{
"displayName": "NOK",
"required": false,
"type": "String",
"value": "NOK"
},
{
"displayName": "NPR",
"required": false,
"type": "String",
"value": "NPR"
},
{
"displayName": "NZD",
"required": false,
"type": "String",
"value": "NZD"
},
{
"displayName": "OMR",
"required": false,
"type": "String",
"value": "OMR"
},
{
"displayName": "PEN",
"required": false,
"type": "String",
"value": "PEN"
},
{
"displayName": "PHP",
"required": false,
"type": "String",
"value": "PHP"
},
{
"displayName": "PKR",
"required": false,
"type": "String",
"value": "PKR"
},
{
"displayName": "PLN",
"required": false,
"type": "String",
"value": "PLN"
},
{
"displayName": "QAR",
"required": false,
"type": "String",
"value": "QAR"
},
{
"displayName": "RON",
"required": false,
"type": "String",
"value": "RON"
},
{
"displayName": "RSD",
"required": false,
"type": "String",
"value": "RSD"
},
{
"displayName": "RUB",
"required": false,
"type": "String",
"value": "RUB"
},
{
"displayName": "RWF",
"required": false,
"type": "String",
"value": "RWF"
},
{
"displayName": "SAR",
"required": false,
"type": "String",
"value": "SAR"
},
{
"displayName": "SCR",
"required": false,
"type": "String",
"value": "SCR"
},
{
"displayName": "SEK",
"required": false,
"type": "String",
"value": "SEK"
},
{
"displayName": "SGD",
"required": false,
"type": "String",
"value": "SGD"
},
{
"displayName": "THB",
"required": false,
"type": "String",
"value": "THB"
},
{
"displayName": "TND",
"required": false,
"type": "String",
"value": "TND"
},
{
"displayName": "TRY",
"required": false,
"type": "String",
"value": "TRY"
},
{
"displayName": "TTD",
"required": false,
"type": "String",
"value": "TTD"
},
{
"displayName": "TWD",
"required": false,
"type": "String",
"value": "TWD"
},
{
"displayName": "TZS",
"required": false,
"type": "String",
"value": "TZS"
},
{
"displayName": "UAH",
"required": false,
"type": "String",
"value": "UAH"
},
{
"displayName": "UGX",
"required": false,
"type": "String",
"value": "UGX"
},
{
"displayName": "USD",
"required": false,
"type": "String",
"value": "USD"
},
{
"displayName": "UYU",
"required": false,
"type": "String",
"value": "UYU"
},
{
"displayName": "VEF",
"required": false,
"type": "String",
"value": "VEF"
},
{
"displayName": "VND",
"required": false,
"type": "String",
"value": "VND"
},
{
"displayName": "VUV",
"required": false,
"type": "String",
"value": "VUV"
},
{
"displayName": "XAF",
"required": false,
"type": "String",
"value": "XAF"
},
{
"displayName": "XCD",
"required": false,
"type": "String",
"value": "XCD"
},
{
"displayName": "XOF",
"required": false,
"type": "String",
"value": "XOF"
},
{
"displayName": "ZAR",
"required": false,
"type": "String",
"value": "ZAR"
},
{
"displayName": "ZMK",
"required": false,
"type": "String",
"value": "ZMK"
}
],
"required": true,
"type": "String"
},
"iBan": {
"description": "The international bank account number of the account. Often used when making or receiving international payments",
"displayName": "IBAN",
"required": false,
"type": "String"
},
"institution": {
"description": "The institution of the bank account",
"displayName": "Institution",
"required": false,
"type": "String"
},
"sortCode": {
"description": "The sort code for the bank account",
"displayName": "Sort Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 0 and 8 characters",
"field": "SortCode"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An account that bank transactions may be recorded against",
"displayName": "Bank Account",
"properties": {
"accountName": {
"description": "Name of the bank account as it appears in Kashflow.",
"displayName": "Account Name",
"required": true,
"type": "String"
},
"balance": {
"description": "The opening balance, in the account currency.",
"displayName": "Balance",
"required": false,
"type": "Number"
},
"currency": {
"description": "The currency of the bank account.",
"displayName": "Currency",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An account that bank transactions may be recorded against",
"displayName": "Bank Account",
"properties": {
"accountName": {
"description": "The name of the bank account in the originating system",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 31 characters.",
"field": "AccountName"
}
]
}
},
"balance": {
"description": "The balance of the bank account",
"displayName": "Balance",
"required": false,
"type": "Number"
},
"currency": {
"description": "The currency of the bank account",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the base currency of the QuickBooks Desktop company",
"field": "Currency"
}
],
"warnings": [
{
"details": "The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is 'Asset.AccountsReceivable','Liability.AccountsPayable' or 'Liability.CreditCard'",
"field": "Currency"
},
{
"details": "Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company",
"field": "Currency"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "Currency"
}
]
}
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 7 characters.",
"field": "NominalCode"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An account that bank transactions may be recorded against",
"displayName": "Bank Account",
"properties": {
"accountName": {
"description": "Name of account as it appears in the chart of accounts or general ledger.",
"displayName": "Account Name",
"required": true,
"type": "String"
},
"accountNumber": {
"description": "User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account.",
"displayName": "Account Number",
"required": true,
"type": "String"
},
"currency": {
"description": "Currency of the bank account.",
"displayName": "Currency",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An account that bank transactions may be recorded against",
"displayName": "Bank Account",
"properties": {
"accountName": {
"description": "The name of the bank account in the originating system",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountName"
},
{
"details": "Should not be longer than 50 characters.",
"field": "AccountName"
}
],
"warnings": []
}
},
"accountNumber": {
"description": "The account number for the bank account",
"displayName": "Account Number",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Should not be longer than 25 characters.",
"field": "AccountNumber"
}
],
"warnings": []
}
},
"currency": {
"description": "The currency of the bank account",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Currency"
},
{
"details": "Must match the company's base currency.",
"field": "Currency"
}
],
"warnings": []
}
},
"iBan": {
"description": "The international bank account number of the account. Often used when making or receiving international payments",
"displayName": "IBAN",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Should be in the international bank account number format.",
"field": "IBan"
}
],
"warnings": []
}
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Should be a number between 1 and 99999999.",
"field": "NominalCode"
}
],
"warnings": []
}
},
"sortCode": {
"description": "The sort code for the bank account",
"displayName": "Sort Code",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Should be a 6 digit number.",
"field": "SortCode"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An account that bank transactions may be recorded against",
"displayName": "Bank Account",
"properties": {
"accountName": {
"description": "The name of the bank account in the originating system",
"displayName": "Name",
"required": true,
"type": "String"
},
"accountNumber": {
"description": "The account number for the bank account",
"displayName": "Account Number",
"required": true,
"type": "String"
},
"accountType": {
"description": "The type of account",
"displayName": "Account Type",
"required": true,
"type": "String"
},
"availableBalance": {
"description": "The available balance of the bank account",
"displayName": "Available Balance",
"required": true,
"type": "Number"
},
"balance": {
"description": "The balance of the bank account",
"displayName": "Balance",
"required": true,
"type": "Number"
},
"currency": {
"description": "The currency of the bank account",
"displayName": "Currency",
"required": true,
"type": "String"
},
"iBan": {
"description": "The international bank account number of the account. Often used when making or receiving international payments",
"displayName": "IBAN",
"required": true,
"type": "String"
},
"institution": {
"description": "The institution of the bank account",
"displayName": "Institution",
"required": true,
"type": "String"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"nominalCode": {
"description": "The external reference given to each nominal account for a business",
"displayName": "Nominal Code",
"required": true,
"type": "String"
},
"overdraftLimit": {
"description": "The pre-arranged overdraft limit of the account",
"displayName": "Overdraft Limit",
"required": true,
"type": "Number"
},
"sortCode": {
"description": "The sort code for the bank account",
"displayName": "Sort Code",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
GET
List bank accounts
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/bankAccounts') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page='http GET '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bankAccounts?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Update bank account
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId"
payload = {}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId"
payload <- "{}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http PUT {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountIdimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bankAccounts/:bankAccountId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create bill credit note
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/billCreditNotes HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/billCreditNotes',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/billCreditNotes", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/billCreditNotes') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotesimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get bill credit note
{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/billCreditNotes/:billCreditNoteId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/billCreditNotes/:billCreditNoteId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/billCreditNotes/:billCreditNoteId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/billCreditNotes/:billCreditNoteId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteIdhttp GET {{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/billCreditNotes/:billCreditNoteId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create-update bill credit note model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/billCreditNotes HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/billCreditNotes',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/billCreditNotes")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/billCreditNotes') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNoteshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNoteswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billCreditNotes")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid currency code",
"field": "Currency"
}
]
}
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Either AccountRef or ItemRef should be specified. If AccountRef is chosen, ID must be specified",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Either AccountRef or ItemRef should be specified. If ItemRef is chosen, ID must be specified",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be positive",
"field": "LineItems.Quantity"
}
]
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be positive",
"field": "LineItems"
}
]
}
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Vendor Credit Memo Number must be specified in this field",
"field": "Note"
}
]
}
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Draft",
"required": false,
"type": "Array",
"value": "Draft"
},
{
"displayName": "Submitted",
"required": false,
"type": "Array",
"value": "Submitted"
},
{
"displayName": "Void",
"required": false,
"type": "Array",
"value": "Void"
}
],
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the credit note has been issued by",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"allocatedOnDate": {
"description": "The date the credit note was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"billCreditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": true,
"type": "String"
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"options": [
{
"displayName": "AED",
"required": false,
"type": "String",
"value": "AED"
},
{
"displayName": "AMD",
"required": false,
"type": "String",
"value": "AMD"
},
{
"displayName": "AOA",
"required": false,
"type": "String",
"value": "AOA"
},
{
"displayName": "ARS",
"required": false,
"type": "String",
"value": "ARS"
},
{
"displayName": "AUD",
"required": false,
"type": "String",
"value": "AUD"
},
{
"displayName": "AWG",
"required": false,
"type": "String",
"value": "AWG"
},
{
"displayName": "AZN",
"required": false,
"type": "String",
"value": "AZN"
},
{
"displayName": "BBD",
"required": false,
"type": "String",
"value": "BBD"
},
{
"displayName": "BDT",
"required": false,
"type": "String",
"value": "BDT"
},
{
"displayName": "BGN",
"required": false,
"type": "String",
"value": "BGN"
},
{
"displayName": "BRL",
"required": false,
"type": "String",
"value": "BRL"
},
{
"displayName": "BWP",
"required": false,
"type": "String",
"value": "BWP"
},
{
"displayName": "CAD",
"required": false,
"type": "String",
"value": "CAD"
},
{
"displayName": "CHF",
"required": false,
"type": "String",
"value": "CHF"
},
{
"displayName": "CLP",
"required": false,
"type": "String",
"value": "CLP"
},
{
"displayName": "CNY",
"required": false,
"type": "String",
"value": "CNY"
},
{
"displayName": "COP",
"required": false,
"type": "String",
"value": "COP"
},
{
"displayName": "CRC",
"required": false,
"type": "String",
"value": "CRC"
},
{
"displayName": "CUC",
"required": false,
"type": "String",
"value": "CUC"
},
{
"displayName": "CUP",
"required": false,
"type": "String",
"value": "CUP"
},
{
"displayName": "CZK",
"required": false,
"type": "String",
"value": "CZK"
},
{
"displayName": "DKK",
"required": false,
"type": "String",
"value": "DKK"
},
{
"displayName": "DOP",
"required": false,
"type": "String",
"value": "DOP"
},
{
"displayName": "EGP",
"required": false,
"type": "String",
"value": "EGP"
},
{
"displayName": "EUR",
"required": false,
"type": "String",
"value": "EUR"
},
{
"displayName": "FJD",
"required": false,
"type": "String",
"value": "FJD"
},
{
"displayName": "GBP",
"required": false,
"type": "String",
"value": "GBP"
},
{
"displayName": "GEL",
"required": false,
"type": "String",
"value": "GEL"
},
{
"displayName": "GHS",
"required": false,
"type": "String",
"value": "GHS"
},
{
"displayName": "GTQ",
"required": false,
"type": "String",
"value": "GTQ"
},
{
"displayName": "GYD",
"required": false,
"type": "String",
"value": "GYD"
},
{
"displayName": "HKD",
"required": false,
"type": "String",
"value": "HKD"
},
{
"displayName": "HNL",
"required": false,
"type": "String",
"value": "HNL"
},
{
"displayName": "HRK",
"required": false,
"type": "String",
"value": "HRK"
},
{
"displayName": "HUF",
"required": false,
"type": "String",
"value": "HUF"
},
{
"displayName": "IDR",
"required": false,
"type": "String",
"value": "IDR"
},
{
"displayName": "ILS",
"required": false,
"type": "String",
"value": "ILS"
},
{
"displayName": "INR",
"required": false,
"type": "String",
"value": "INR"
},
{
"displayName": "ISK",
"required": false,
"type": "String",
"value": "ISK"
},
{
"displayName": "JMD",
"required": false,
"type": "String",
"value": "JMD"
},
{
"displayName": "JPY",
"required": false,
"type": "String",
"value": "JPY"
},
{
"displayName": "KES",
"required": false,
"type": "String",
"value": "KES"
},
{
"displayName": "KRW",
"required": false,
"type": "String",
"value": "KRW"
},
{
"displayName": "KWD",
"required": false,
"type": "String",
"value": "KWD"
},
{
"displayName": "KYD",
"required": false,
"type": "String",
"value": "KYD"
},
{
"displayName": "KZT",
"required": false,
"type": "String",
"value": "KZT"
},
{
"displayName": "LAK",
"required": false,
"type": "String",
"value": "LAK"
},
{
"displayName": "LBP",
"required": false,
"type": "String",
"value": "LBP"
},
{
"displayName": "LKR",
"required": false,
"type": "String",
"value": "LKR"
},
{
"displayName": "LTL",
"required": false,
"type": "String",
"value": "LTL"
},
{
"displayName": "LVL",
"required": false,
"type": "String",
"value": "LVL"
},
{
"displayName": "MAD",
"required": false,
"type": "String",
"value": "MAD"
},
{
"displayName": "MDL",
"required": false,
"type": "String",
"value": "MDL"
},
{
"displayName": "MGA",
"required": false,
"type": "String",
"value": "MGA"
},
{
"displayName": "MUR",
"required": false,
"type": "String",
"value": "MUR"
},
{
"displayName": "MVR",
"required": false,
"type": "String",
"value": "MVR"
},
{
"displayName": "MWK",
"required": false,
"type": "String",
"value": "MWK"
},
{
"displayName": "MXN",
"required": false,
"type": "String",
"value": "MXN"
},
{
"displayName": "MYR",
"required": false,
"type": "String",
"value": "MYR"
},
{
"displayName": "MZN",
"required": false,
"type": "String",
"value": "MZN"
},
{
"displayName": "NAD",
"required": false,
"type": "String",
"value": "NAD"
},
{
"displayName": "NGN",
"required": false,
"type": "String",
"value": "NGN"
},
{
"displayName": "NOK",
"required": false,
"type": "String",
"value": "NOK"
},
{
"displayName": "NPR",
"required": false,
"type": "String",
"value": "NPR"
},
{
"displayName": "NZD",
"required": false,
"type": "String",
"value": "NZD"
},
{
"displayName": "OMR",
"required": false,
"type": "String",
"value": "OMR"
},
{
"displayName": "PEN",
"required": false,
"type": "String",
"value": "PEN"
},
{
"displayName": "PHP",
"required": false,
"type": "String",
"value": "PHP"
},
{
"displayName": "PKR",
"required": false,
"type": "String",
"value": "PKR"
},
{
"displayName": "PLN",
"required": false,
"type": "String",
"value": "PLN"
},
{
"displayName": "QAR",
"required": false,
"type": "String",
"value": "QAR"
},
{
"displayName": "RON",
"required": false,
"type": "String",
"value": "RON"
},
{
"displayName": "RSD",
"required": false,
"type": "String",
"value": "RSD"
},
{
"displayName": "RUB",
"required": false,
"type": "String",
"value": "RUB"
},
{
"displayName": "RWF",
"required": false,
"type": "String",
"value": "RWF"
},
{
"displayName": "SAR",
"required": false,
"type": "String",
"value": "SAR"
},
{
"displayName": "SCR",
"required": false,
"type": "String",
"value": "SCR"
},
{
"displayName": "SEK",
"required": false,
"type": "String",
"value": "SEK"
},
{
"displayName": "SGD",
"required": false,
"type": "String",
"value": "SGD"
},
{
"displayName": "THB",
"required": false,
"type": "String",
"value": "THB"
},
{
"displayName": "TND",
"required": false,
"type": "String",
"value": "TND"
},
{
"displayName": "TRY",
"required": false,
"type": "String",
"value": "TRY"
},
{
"displayName": "TTD",
"required": false,
"type": "String",
"value": "TTD"
},
{
"displayName": "TWD",
"required": false,
"type": "String",
"value": "TWD"
},
{
"displayName": "TZS",
"required": false,
"type": "String",
"value": "TZS"
},
{
"displayName": "UAH",
"required": false,
"type": "String",
"value": "UAH"
},
{
"displayName": "UGX",
"required": false,
"type": "String",
"value": "UGX"
},
{
"displayName": "USD",
"required": false,
"type": "String",
"value": "USD"
},
{
"displayName": "UYU",
"required": false,
"type": "String",
"value": "UYU"
},
{
"displayName": "VEF",
"required": false,
"type": "String",
"value": "VEF"
},
{
"displayName": "VND",
"required": false,
"type": "String",
"value": "VND"
},
{
"displayName": "VUV",
"required": false,
"type": "String",
"value": "VUV"
},
{
"displayName": "XAF",
"required": false,
"type": "String",
"value": "XAF"
},
{
"displayName": "XCD",
"required": false,
"type": "String",
"value": "XCD"
},
{
"displayName": "XOF",
"required": false,
"type": "String",
"value": "XOF"
},
{
"displayName": "ZAR",
"required": false,
"type": "String",
"value": "ZAR"
},
{
"displayName": "ZMK",
"required": false,
"type": "String",
"value": "ZMK"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not specified, defaults to the company's native currency",
"field": "Currency"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Amount of sales tax for the BillCreditNoteLineItem in company's native currency.",
"field": "LineItems.TaxAmount"
}
],
"warnings": [
{
"details": "Must be positive for bill items and negative for credit items. If not specified, defaults to the tax correct tax rate amount for the category of the bill.",
"field": "LineItems.TaxAmount"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Up to a maximum of 40 line items may be specified",
"field": "LineItems"
}
]
}
},
"supplierRef": {
"description": "Reference to the supplier the credit note has been issued by",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater than 0 and must be equal to the sum of the line item total amounts.",
"field": "TotalAmount"
}
]
}
},
"totalTaxAmount": {
"description": "The amount of tax for the credit note",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater than 0 and must be equal to the sum of the line item tax amounts.",
"field": "TotalTaxAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.AccountRef"
}
],
"warnings": []
}
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be greater than 225 characters long.",
"field": "LineItems.Description"
}
],
"warnings": []
}
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "LineItems.SubTotal"
}
]
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "LineItems.TaxAmount"
}
]
}
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TotalAmount"
}
],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "LineItems.TotalAmount"
},
{
"details": "Must be greater than zero.",
"field": "LineItems.TotalAmount"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"remainingCredit": {
"description": "Unused balance of total amount originally raised",
"displayName": "Remaining Credit",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "RemainingCredit"
}
]
}
},
"subTotal": {
"description": "The amount of the credit note, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "SubTotal"
}
]
}
},
"supplierRef": {
"description": "Reference to the supplier the credit note has been issued by",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "TotalAmount"
},
{
"details": "Must be greater than zero.",
"field": "TotalAmount"
}
]
}
},
"totalDiscount": {
"description": "The value, in the given credit note currency, of any discounts applied",
"displayName": "Discount Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "TotalDiscount"
}
]
}
},
"totalTaxAmount": {
"description": "The amount of tax for the credit note",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "TotalTaxAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": true,
"type": "String"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be provided for 'Discount' type items",
"field": "LineItems.Quantity"
}
]
}
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"tracking": {
"description": "A collection of items this line item is being tracked against",
"displayName": "Accounts Payable Tracking",
"properties": {
"categoryRefs": {
"description": "A collection of categories this line item is being tracked against",
"displayName": "Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
}
},
"required": false,
"type": "Object"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be provided for 'Discount' type items",
"field": "LineItems.UnitAmount"
}
]
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the credit note has been issued by",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the default currency of the supplier.",
"field": "Currency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code that matches the currency of the supplier.",
"field": "Currency"
},
{
"details": "Can only be set if the QuickBooks Desktop company has Multicurrency enabled.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.",
"field": "CurrencyRate"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing nominal account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Account type must be Asset, Liability or Expense and not Accounts Payable",
"field": "LineItems.AccountRef"
}
],
"warnings": [
{
"details": "Can't include both AccountRef and ItemRef",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not be longer than 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing item type.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Item type must not be Discount or Sale-Tax items",
"field": "LineItems.ItemRef"
}
],
"warnings": [
{
"details": "Can't include both AccountRef and ItemRef",
"field": "LineItems.ItemRef"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must match quantity * unit amount of line",
"field": "LineItems.SubTotal"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Cannot be mapped directly into QuickBooks Desktop and will only be used for validation purposes",
"field": "LineItems.TaxAmount"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only valid for UK or CA versions of QuickBooks Desktop with VAT enabled",
"field": "TaxRateRef.Id"
},
{
"details": "Must match the ID of an existing tax rate",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must match subtotal + tax amount of line",
"field": "LineItems.TotalAmount"
}
],
"warnings": []
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this line item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tracking category.",
"field": "TrackingCategoryRefs.Id"
}
]
}
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4000 characters.",
"field": "Note"
}
]
}
},
"paymentAllocations": {
"description": "A collection of payments that are allocated to (i.e. spend) the credit note",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "If set, must match issue date on the bill credit note",
"field": "Allocation.AllocatedOnDate"
}
]
}
},
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "If set, must match currency on the bill credit note",
"field": "Allocation.Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the transaction",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "If set, must match currency rate on the bill credit note",
"field": "Allocation.CurrencyRate"
}
]
}
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match total amount on the bill credit note",
"field": "Allocation.TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing credit card account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": " Account type must be of type Credit Card",
"field": "Payment.AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "$ set, must match currency on the {topLevelItem}",
"field": "Payment.Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "If set, must match currency rate on the bill credit note",
"field": "Payment.CurrencyRate"
}
]
}
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match issue date on the bill credit note",
"field": "Payment.PaidOnDate"
}
]
}
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": " Must match total amount on the bill credit note",
"field": "Payment.TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "If a payment allocation is provided, a credit card credit will created in QuickBooksDesktop, if left as null or empty, a {topLevelItem} will be created",
"field": "PaymentAllocations"
}
],
"warnings": [
{
"details": "A maximum of one payment allocation may be provided per bill credit note",
"field": "PaymentAllocations"
}
]
}
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
},
{
"displayName": "Paid",
"required": false,
"type": "String",
"value": "Paid"
},
{
"displayName": "Void",
"required": false,
"type": "String",
"value": "Void"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If a bill credit note is pushed with a status of void, then all the amounts in the bill credit note must be 0",
"field": "Status"
},
{
"details": "If a bill credit note is pushed without payment allocations, then the status must be Submitted, if pushed with payment allocations, then the status must be paid",
"field": "Status"
}
],
"warnings": [
{
"details": "If a bill credit note is pushed with a total amount of 0, then the status must be Paid or Void",
"field": "Status"
}
]
}
},
"subTotal": {
"description": "The amount of the credit note, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the totalAmount - taxAmount",
"field": "SubTotal"
}
]
}
},
"supplierRef": {
"description": "Reference to the supplier the credit note has been issued by",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing supplier",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "If a bill credit note is pushed with a total amount of 0, it will automatically be marked as paid in QuickBooks Desktop",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Must match the sum of line items ((quantity * unit price) - discount + tax)",
"field": "TotalAmount"
}
]
}
},
"totalTaxAmount": {
"description": "The amount of tax for the credit note",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Cannot be mapped directly into QuickBooks Desktop and will only be used for validation purposes",
"field": "TotalTaxAmount"
},
{
"details": "Must match sum of total of tax from the line items",
"field": "TotalTaxAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"billCreditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": false,
"type": "String"
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if Currency is not the base currency.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "If the issue date is not supplied, the current date on the server is used",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Required if the expense line is account based. If AccountRef is specified, ItemRef must be null.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not be longer than 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Required if the expense line is item based. If ItemRef is specified, AccountRef must be null.",
"field": "ItemRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax code.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments that are allocated to (i.e. spend) the credit note",
"displayName": "Payment Allocations",
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Payment Allocations are no longer valid for BillCreditNotes and must not be provided, use the DirectCost data type to push credit card credits.",
"field": "PaymentAllocations"
}
]
}
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
},
{
"displayName": "Paid",
"required": false,
"type": "String",
"value": "Paid"
}
],
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the credit note has been issued by",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"billCreditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": false,
"type": "String"
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if Currency is not the base currency.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "If the issue date is not supplied, the current date on the server is used",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Required if the expense line is account based. If AccountRef is specified, ItemRef must be null.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not be longer than 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Required if the expense line is item based. If ItemRef is specified, AccountRef must be null.",
"field": "ItemRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax code.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments that are allocated to (i.e. spend) the credit note",
"displayName": "Payment Allocations",
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Payment Allocations are no longer valid for BillCreditNotes and must not be provided, use the DirectCost data type to push credit card credits.",
"field": "PaymentAllocations"
}
]
}
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
},
{
"displayName": "Paid",
"required": false,
"type": "String",
"value": "Paid"
}
],
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the credit note has been issued by",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"billCreditNoteNumber": {
"description": "The reference number for this bill credit note",
"displayName": "Bill Credit Note Number",
"required": true,
"type": "String"
},
"currency": {
"description": "The currency in which the bill credit note is issued.",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "This must match the supplier's default currency.",
"field": "currency"
}
]
}
},
"issueDate": {
"description": "Date when the bill credit note was issued.",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "Line items of the bill credit note.",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Identifier for the account.",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "Identifier of the account.",
"displayName": "Account Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "accountRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Description of the bill credit note line item.",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 60 characters.",
"field": "lineItems.description"
}
]
}
},
"taxAmount": {
"description": "Tax of the bill credit note line item.",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Tax rate reference of a bill credit note line item.",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "ID of the tax rate.",
"displayName": "Tax Rate Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tax rate.",
"field": "taxRateRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the bill credit note line item, inclusive of the tax amount.",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"trackingCategoryRefs": {
"description": "Tracking categories for the line item",
"displayName": "Tracking Categories",
"properties": {
"id": {
"description": "Prefixed identifier for tracking category e.g. project_{x}, department_{x}, costcode_{x}",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Cost codes assigned with costcode_{x} must exist in Sage50 and must be assigned in conjunction with a project",
"field": "trackingCategoryRefs.id"
},
{
"details": "Projects assigned with project_{x} must exist in Sage50 and must be assigned in conjunction with a cost code",
"field": "trackingCategoryRefs.id"
},
{
"details": "Departments assigned with department_{x} must exist in Sage50",
"field": "trackingCategoryRefs.id"
}
]
}
}
},
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "To be used for any additional information associated with the bill credit note line item.",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Maximum 60 characters",
"field": "note"
}
]
}
},
"status": {
"description": "The status of the bill credit note",
"displayName": "Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Supplier providing the bill credit note.",
"displayName": "Supplier",
"properties": {
"id": {
"description": "Identifier of the supplier.",
"displayName": "Supplier Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing supplier and have a max length of 8 characters.",
"field": "supplierRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"billCreditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Should not be longer than 25 characters.",
"field": "BillCreditNoteNumber"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If supplied, must match the currency of the supplier.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Description"
}
],
"warnings": [
{
"details": "Should not be longer than 2000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TaxAmount"
}
],
"warnings": []
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax rate.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If supplied, must match the total of the line including tax.",
"field": "LineItems.TotalAmount"
}
],
"warnings": []
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"supplierRef": {
"description": "Reference to the supplier the credit note has been issued by",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing supplier.",
"field": "SupplierRef.Id"
},
{
"details": "The supplier must be in the same location as the company.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If supplied, must match the sum of all line item total amounts.",
"field": "TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"allocatedOnDate": {
"description": "The date the credit note was allocated",
"displayName": "Allocated On Date",
"required": false,
"type": "DateTime"
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"options": [
{
"displayName": "Australian Dollar",
"required": false,
"type": "String",
"value": "AUD"
},
{
"displayName": "Canadian Dollar",
"required": false,
"type": "String",
"value": "CAD"
},
{
"displayName": "Pound Sterling",
"required": false,
"type": "String",
"value": "GBP"
},
{
"displayName": "US Dollar",
"required": false,
"type": "String",
"value": "USD"
},
{
"displayName": "Rand",
"required": false,
"type": "String",
"value": "ZAR"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided if CurrencyRate is set.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must contain no more than 1000 characters.",
"field": "LineItems.Description"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Must not be negative.",
"field": "LineItems.TaxAmount"
}
],
"warnings": []
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be an existing tax rate in Sage Intacct.",
"field": "TaxRateRef.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided when TaxAmount is set.",
"field": "LineItems.TaxRateRef"
}
],
"warnings": []
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this line item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must not be negative.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must contain at least one line item.",
"field": "LineItems"
}
],
"warnings": []
}
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must contain no more than 1000 characters.",
"field": "Note"
}
],
"warnings": []
}
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Draft",
"required": false,
"type": "String",
"value": "Draft"
},
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not specified will default to Submitted.",
"field": "Status"
}
],
"warnings": []
}
},
"supplierRef": {
"description": "Reference to the supplier the credit note has been issued by",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"allocatedOnDate": {
"description": "The date the credit note was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"billCreditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": true,
"type": "String"
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": true,
"type": "String"
},
"discountAmount": {
"description": "The value, in the given credit note currency, of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the item referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"tracking": {
"description": "A collection of items this line item is being tracked against",
"displayName": "Accounts Payable Tracking",
"properties": {
"categoryRefs": {
"description": "A collection of categories this line item is being tracked against",
"displayName": "Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"customerRef": {
"description": "Reference to the customer this line item is being tracked against",
"displayName": "Customer Reference",
"properties": {
"companyName": {
"description": "The name of the customer referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"isBilledTo": {
"description": "The type of item this line item is billed to.",
"displayName": "Is Billed To",
"required": true,
"type": "String"
},
"isRebilledTo": {
"description": "The type of item this line item is billed to",
"displayName": "Is Rebilled To",
"required": true,
"type": "String"
},
"projectRef": {
"description": "Reference to the project this line item is being tracked against",
"displayName": "Project Reference",
"properties": {
"id": {
"description": "The reference identifier for the Project",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the Project referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this line item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": true,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments that are allocated to (i.e. spend) the credit note",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the transaction",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the allocated payment",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"note": {
"description": "Any additional text based information associated with the allocated payment",
"displayName": "Note",
"required": true,
"type": "String"
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime"
},
"reference": {
"description": "Reference associated with the allocated payment",
"displayName": "Reference",
"required": true,
"type": "String"
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array"
},
"remainingCredit": {
"description": "Unused balance of total amount originally raised",
"displayName": "Remaining Credit",
"required": true,
"type": "Number"
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"required": true,
"type": "String"
},
"subTotal": {
"description": "The amount of the credit note, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"supplierRef": {
"description": "Reference to the supplier the credit note has been issued by",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"supplierName": {
"description": "The name of the supplier referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"totalDiscount": {
"description": "The value, in the given credit note currency, of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"totalTaxAmount": {
"description": "The amount of tax for the credit note",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"withholdingTax": {
"description": "A collection of tax deductions",
"displayName": "Withholding Tax",
"properties": {
"amount": {
"description": "Deduction amount",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"name": {
"description": "Name of the deduction",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.",
"displayName": "Accounts Payable Credit Note",
"properties": {
"billCreditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 225 characters long.",
"field": "BillCreditNoteNumber"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.AccountRef"
}
],
"warnings": []
}
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "ItemRef.Id"
},
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TotalAmount"
}
],
"warnings": []
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this line item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TrackingCategoryRefs.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Tracking categories must not have the same parent tracking category.",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "Maximum of 2 Tracking Categories.",
"field": "LineItems.TrackingCategoryRefs"
}
],
"warnings": []
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Draft",
"required": false,
"type": "String",
"value": "Draft"
},
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
},
{
"displayName": "Paid",
"required": false,
"type": "String",
"value": "Paid"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Status"
}
],
"warnings": []
}
},
"supplierRef": {
"description": "Reference to the supplier the credit note has been issued by",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "SupplierRef.Id"
},
{
"details": "Must match the ID of an existing supplier.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided and must equal the sum of the link items amount.",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Must be greater than zero.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}
GET
List bill credit notes
{{baseUrl}}/companies/:companyId/data/billCreditNotes
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/billCreditNotes" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/billCreditNotes?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/billCreditNotes?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/billCreditNotes?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/billCreditNotes?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/billCreditNotes?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billCreditNotes',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/billCreditNotes?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billCreditNotes',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/billCreditNotes');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billCreditNotes',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/billCreditNotes?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/billCreditNotes');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/billCreditNotes');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/billCreditNotes?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/billCreditNotes"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/billCreditNotes"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/billCreditNotes') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/billCreditNotes";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/billCreditNotes?page='http GET '{{baseUrl}}/companies/:companyId/data/billCreditNotes?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/billCreditNotes?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/billCreditNotes?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Update bill credit note
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId"
payload = {}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId"
payload <- "{}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http PUT {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteIdimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billCreditNotes/:billCreditNoteId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create bill payments
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/billPayments HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/billPayments',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/billPayments", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/billPayments') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPaymentsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
DELETE
Delete bill payment
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}DELETE /baseUrl/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentIdhttp DELETE {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentIdwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get bill payment
{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/billPayments/:billPaymentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/billPayments/:billPaymentId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/billPayments/:billPaymentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/billPayments/:billPaymentId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentIdhttp GET {{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/billPayments/:billPaymentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create bill payment model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/billPayments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/billPayments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/billPayments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/billPayments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPaymentshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPaymentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPaymentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/billPayments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "An account ID must be provided if not allocating against bill",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid currency code",
"field": "Currency"
}
]
}
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "AllocatedOnDate must be specified and be later than the issue date of the bill",
"field": "Lines.AllocatedOnDate"
}
]
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the payment has been sent to",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must match the sum of the link amounts.",
"field": "Lines.Amount"
}
],
"warnings": []
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Bill",
"required": false,
"type": "String",
"value": "Bill"
},
{
"displayName": "Bill Credit Note",
"required": false,
"type": "String",
"value": "CreditNote"
},
{
"displayName": "Other",
"required": false,
"type": "String",
"value": "Other"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Only one line may be specified",
"field": "Lines"
}
]
}
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of the line amounts.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"options": [
{
"displayName": "Australian Dollar",
"required": false,
"type": "String",
"value": "AUD"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Currency"
}
],
"warnings": []
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Date"
}
],
"warnings": []
}
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines.Amount"
}
],
"warnings": []
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Amount"
}
],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "Links.Amount"
}
]
}
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Id"
}
],
"warnings": []
}
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"required": false,
"type": "String",
"value": "Bill"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Type"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines.Links"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines"
}
],
"warnings": []
}
},
"reference": {
"description": "A user friendly reference for the payment",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be greater than 8 characters long.",
"field": "Reference"
}
],
"warnings": []
}
},
"supplierRef": {
"description": "Reference to the supplier the payment has been sent to",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "SupplierRef.Id"
},
{
"details": "Must match the ID of an existing supplier.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided and must equal the sum of the link items amount.",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "TotalAmount"
},
{
"details": "Must be greater than zero.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account of type 'Bank' OR type 'Credit Card'",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "If the currency is set make sure it's the same as the 'Bill' and/or 'VendorCredit' currency",
"field": "Currency"
}
]
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Ensure the status of the linked bill is either 'PartiallyPaid' or 'Submitted'",
"field": "Links.Id"
}
]
}
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Bill",
"required": false,
"type": "String",
"value": "Bill"
},
{
"displayName": "Bill Credit Note",
"required": false,
"type": "String",
"value": "CreditNote"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"reference": {
"description": "A user friendly reference for the payment",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "This field can be used to provide a tracking category id (Location only)",
"field": "Reference"
}
],
"warnings": [
{
"details": "The id format should be 'location-'",
"field": "Reference"
}
]
}
},
"supplierRef": {
"description": "Reference to the supplier the payment has been sent to",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
} RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If an ID which corresponds to a bank account is provided, a 'bill payment check' will be added to Quickbooks Desktop, If an ID which corresponds to a credit card account is provided, a 'bill payment credit card' will be added Quickbooks Desktop. ",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing Bank or Credit Card account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the default currency of the supplier",
"field": "Currency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code that matches the currency of the supplier",
"field": "Currency"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.",
"field": "CurrencyRate"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Amount plus the sum of amounts in the links must equal 0",
"field": "Lines.Amount"
}
]
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Bill",
"required": false,
"type": "String",
"value": "Bill"
},
{
"displayName": "Credit Note",
"required": false,
"type": "String",
"value": "CreditNote"
}
],
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Exactly 1 link with type 'Bill' must be specified per line",
"field": "Links.Type"
}
]
}
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the payment has been sent to",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing supplier.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of amounts in the lines",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "Required if TotalAmount is greater than zero.",
"field": "AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if Currency is not the base currency.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Amount and sum of Links must sum to zero.",
"field": "Lines.Amount"
}
]
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Bill",
"required": false,
"type": "String",
"value": "Bill"
},
{
"displayName": "Credit Note",
"required": false,
"type": "String",
"value": "CreditNote"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentMethodRef": {
"description": "The method of payment",
"displayName": "Payment Method Reference",
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "If provided it will be ignored.",
"field": "PaymentMethodRef"
}
]
}
},
"supplierRef": {
"description": "Reference to the supplier the payment has been sent to",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be the ID of the Supplier associated with the Bill or Credit Note.",
"field": "SupplierRef"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "Required if TotalAmount is greater than zero.",
"field": "AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if Currency is not the base currency.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Amount and sum of Links must sum to zero.",
"field": "Lines.Amount"
}
]
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Bill",
"required": false,
"type": "String",
"value": "Bill"
},
{
"displayName": "Credit Note",
"required": false,
"type": "String",
"value": "CreditNote"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentMethodRef": {
"description": "The method of payment",
"displayName": "Payment Method Reference",
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "If provided it will be ignored.",
"field": "PaymentMethodRef"
}
]
}
},
"supplierRef": {
"description": "Reference to the supplier the payment has been sent to",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be the ID of the Supplier associated with the Bill or Credit Note.",
"field": "SupplierRef"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "The bank account to pay this bill from.",
"displayName": "Bank Account",
"properties": {
"id": {
"description": "Nominal code of the bank account.",
"displayName": "Account Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing bank account and have a max length of 8 characters.",
"field": "accountRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"date": {
"description": "The date this payment was issued.",
"displayName": "Issue Date",
"required": true,
"type": "Number"
},
"lines": {
"description": "Line items of the payment.",
"displayName": "Line Items",
"properties": {
"amount": {
"description": "The amount of this line item",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "this must equal the negative of the sum of the link amounts"
}
],
"warnings": []
}
},
"links": {
"description": "Links to the bills being paid.",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount to be added to the value of the bill",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "When paying off a bill, this value will be negative"
}
],
"warnings": []
}
},
"id": {
"description": "The ID of the bill to pay",
"displayName": "Bill Id",
"required": true,
"type": "String"
},
"type": {
"description": "The type of the item to be paid",
"displayName": "Payment Link Type",
"options": [
{
"displayName": "Bill",
"required": false,
"type": "String",
"value": "Bill"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Sage 50 only supports one line item per bill payment so all lines will be merged together in the response."
}
],
"warnings": []
}
},
"note": {
"description": "A description of the payment.",
"displayName": "Note",
"required": false,
"type": "Number"
},
"reference": {
"description": "The user reference for this bill payment.",
"displayName": "Reference",
"required": false,
"type": "Number"
},
"supplierRef": {
"description": "Supplier to be paid.",
"displayName": "Supplier",
"properties": {
"id": {
"description": "Identifier of the supplier.",
"displayName": "Supplier Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing supplier and have a max length of 8 characters.",
"field": "supplierRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount being paid to the supplier.",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "This must equal the sum of the line amounts"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Required unless the BillPayment is only allocating a Credit Note.",
"field": "AccountRef"
}
]
}
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If supplied, must match the currency of the supplier.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Date"
}
],
"warnings": []
}
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Amount"
}
],
"warnings": [
{
"details": "Must be greater than zero except when Link Type is Bill.",
"field": "Links.Amount"
}
]
}
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Id"
}
],
"warnings": []
}
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Bill",
"required": false,
"type": "String",
"value": "Bill"
},
{
"displayName": "PaymentOnAccount",
"required": false,
"type": "String",
"value": "PaymentOnAccount"
},
{
"displayName": "Refund",
"required": false,
"type": "String",
"value": "Refund"
},
{
"displayName": "CreditNote",
"required": false,
"type": "String",
"value": "CreditNote"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Type"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines.Links"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Should not be longer than 25 characters.",
"field": "Note"
}
],
"warnings": []
}
},
"supplierRef": {
"description": "Reference to the supplier the payment has been sent to",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing supplier.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Must be zero when allocating against Bills using a Credit Note only.",
"field": "TotalAmount"
},
{
"details": "Must equal the sum of the link items amount.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be an account of type BankAccount and compatible with the type of PaymentMethodRef",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"options": [
{
"displayName": "Australian Dollar",
"required": false,
"type": "String",
"value": "AUD"
},
{
"displayName": "Canadian Dollar",
"required": false,
"type": "String",
"value": "CAD"
},
{
"displayName": "Pound Sterling",
"required": false,
"type": "String",
"value": "GBP"
},
{
"displayName": "US Dollar",
"required": false,
"type": "String",
"value": "USD"
},
{
"displayName": "Rand",
"required": false,
"type": "String",
"value": "ZAR"
}
],
"required": false,
"type": "String"
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be a negative amount",
"field": "Lines.Amount"
}
]
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Bill",
"required": false,
"type": "String",
"value": "Bill"
},
{
"displayName": "CreditNote",
"required": false,
"type": "String",
"value": "CreditNote"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 1000 characters",
"field": "Note"
}
]
}
},
"paymentMethodRef": {
"description": "The method of payment",
"displayName": "Payment Method Reference",
"properties": {
"id": {
"description": "The reference identifier for the payment method",
"displayName": "Identifier",
"options": [
{
"displayName": "Credit Card",
"required": false,
"type": "String",
"value": "3"
},
{
"displayName": "EFT",
"required": false,
"type": "String",
"value": "5"
},
{
"displayName": "Cash",
"required": false,
"type": "String",
"value": "6"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"supplierRef": {
"description": "Reference to the supplier the payment has been sent to",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a positive amount",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the currency of the linked transaction",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": true,
"type": "String"
},
"paymentMethodRef": {
"description": "The method of payment",
"displayName": "Payment Method Reference",
"properties": {
"id": {
"description": "The reference identifier for the payment method",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the payment method referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"reference": {
"description": "A user friendly reference for the payment",
"displayName": "Reference",
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the payment has been sent to",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"supplierName": {
"description": "The name of the supplier referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided if paying a bill from a Bank Account.",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided if paying a bill from a Bank Account.",
"field": "AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be the company's base currency when pushing a batch payment.",
"field": "Currency"
}
],
"warnings": []
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Date"
}
],
"warnings": []
}
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines.Amount"
}
],
"warnings": []
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Amount"
}
],
"warnings": []
}
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Bill and Bill Credit Note ID must be provided in order to allocate a Bill Credit Note to a Bill.",
"field": "Links.Id"
},
{
"details": "Must be provided.",
"field": "Links.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "Links.Id"
}
]
}
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Bill",
"required": false,
"type": "String",
"value": "Bill"
},
{
"displayName": "Credit Note",
"required": false,
"type": "String",
"value": "CreditNote"
},
{
"displayName": "Bill Payment",
"required": false,
"type": "String",
"value": "BillPayment"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Type"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "When a single line is provided, must only contain a single Link of type Bill, CreditNote or BillPayment, or two Links of type CreditNote and Bill for a credit note allocation.",
"field": "Lines.Links"
},
{
"details": "When more than one line is provided, it must only contain a single Link of type Bill.",
"field": "Lines.Links"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "When more than one line is provided, a batch payment will be created.",
"field": "Lines"
}
],
"warnings": []
}
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Must match the sum of line amounts.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)",
"displayName": "BillPayment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided when making a payment to an invoice and/or a payment on account",
"field": "AccountRef"
}
]
}
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match supplier's currency",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater or equal to 0",
"field": "CurrencyRate"
}
]
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be less than 0 for links of type Bill and PaymentOnAccount or greater than 0 for links of type CreditNote",
"field": "Links.Amount"
}
]
}
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Bill",
"required": false,
"type": "String",
"value": "Bill"
},
{
"displayName": "PaymentOnAccount",
"required": false,
"type": "String",
"value": "PaymentOnAccount"
},
{
"displayName": "CreditNote",
"required": false,
"type": "String",
"value": "CreditNote"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "If using a bill credit note to pay a bill must contain 1 bill payment line link of type CreditNote and 1 bill payment line link of type Bill. Otherwise must contain at least 1 bill payment line linkof type Bill or PaymentOnAccount",
"field": "Lines.Links"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must contain 1 bill payment line",
"field": "Lines"
}
]
}
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the payment has been sent to",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}
GET
List bill payments
{{baseUrl}}/companies/:companyId/data/billPayments
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/billPayments?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/billPayments" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/billPayments?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/billPayments?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/billPayments?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/billPayments?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/billPayments?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/billPayments?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/billPayments?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/billPayments?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/billPayments?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/billPayments?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billPayments',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/billPayments?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/billPayments?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/billPayments?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/billPayments?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billPayments',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/billPayments');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/billPayments',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/billPayments?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/billPayments?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/billPayments?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/billPayments?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/billPayments?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/billPayments');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/billPayments');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/billPayments?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/billPayments?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/billPayments?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/billPayments"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/billPayments"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/billPayments?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/billPayments') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/billPayments";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/billPayments?page='http GET '{{baseUrl}}/companies/:companyId/data/billPayments?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/billPayments?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/billPayments?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create bill
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/bills HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/bills',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/bills", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/bills') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/billsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
DELETE
Delete bill
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}DELETE /baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billIdhttp DELETE {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billIdwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Download bill attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download
QUERY PARAMS
attachmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/downloadhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/downloadwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/downloadimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get bill attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId
QUERY PARAMS
attachmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentIdhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get bill
{{baseUrl}}/companies/:companyId/data/bills/:billId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/bills/:billId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/bills/:billId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/bills/:billId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/bills/:billId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/bills/:billId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/bills/:billId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/bills/:billId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/bills/:billId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/bills/:billId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/bills/:billId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/bills/:billId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/bills/:billId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bills/:billId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/bills/:billId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/bills/:billId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/bills/:billId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/bills/:billId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bills/:billId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/bills/:billId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bills/:billId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/bills/:billId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/bills/:billId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/bills/:billId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/bills/:billId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/bills/:billId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/bills/:billId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/bills/:billId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/bills/:billId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/bills/:billId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/bills/:billId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/bills/:billId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/bills/:billId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/bills/:billId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/bills/:billId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/bills/:billId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/bills/:billIdhttp GET {{baseUrl}}/companies/:companyId/data/bills/:billIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/bills/:billIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/bills/:billId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create-update bill model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/bills HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/bills',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/bills")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/bills') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/billshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/billswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/billsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/bills")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"properties": {
"dueDate": {
"description": "The date the bill is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime"
},
"issueDate": {
"description": "The date of the bill as recorded in the originating system.",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the bill",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Please ensure that the account posting setup for this account is valid before pushing",
"field": "AccountRef.Id"
},
{
"details": "Either AccountRef or ItemRef should be specified. If AccountRef is chosen, ID must be specified",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": false,
"type": "Number"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Either AccountRef or ItemRef should be specified. If ItemRef is chosen, ID must be specified",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be positive",
"field": "LineItems.Quantity"
}
]
}
},
"tracking": {
"description": "A collection of items this line item is being tracked against",
"displayName": "Accounts Payable Tracking",
"properties": {
"categoryRefs": {
"description": "A collection of categories this line item is being tracked against",
"displayName": "Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Every Tracking Category specified will be applied to every line item",
"field": "CategoryRefs.Id"
}
],
"warnings": [
{
"details": "Must not be a parent Tracking Category. All Tracking Category specified must have different parent categories",
"field": "CategoryRefs.Id"
}
]
}
}
},
"required": true,
"type": "Array"
}
},
"required": false,
"type": "Object"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the bill",
"displayName": "Note",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Supplier Invoice Number must be specified in this field",
"field": "Note"
}
]
}
},
"status": {
"description": "The current state of the bill",
"displayName": "Bill Status",
"options": [
{
"displayName": "Draft",
"required": false,
"type": "Array",
"value": "Draft"
},
{
"displayName": "Void",
"required": false,
"type": "Array",
"value": "Void"
},
{
"displayName": "Open",
"required": false,
"type": "Array",
"value": "Open"
}
],
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the bill has been received from",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"properties": {
"currency": {
"description": "Currency of the bill",
"displayName": "Currency",
"options": [
{
"displayName": "AED",
"required": false,
"type": "String",
"value": "AED"
},
{
"displayName": "AMD",
"required": false,
"type": "String",
"value": "AMD"
},
{
"displayName": "AOA",
"required": false,
"type": "String",
"value": "AOA"
},
{
"displayName": "ARS",
"required": false,
"type": "String",
"value": "ARS"
},
{
"displayName": "AUD",
"required": false,
"type": "String",
"value": "AUD"
},
{
"displayName": "AWG",
"required": false,
"type": "String",
"value": "AWG"
},
{
"displayName": "AZN",
"required": false,
"type": "String",
"value": "AZN"
},
{
"displayName": "BBD",
"required": false,
"type": "String",
"value": "BBD"
},
{
"displayName": "BDT",
"required": false,
"type": "String",
"value": "BDT"
},
{
"displayName": "BGN",
"required": false,
"type": "String",
"value": "BGN"
},
{
"displayName": "BRL",
"required": false,
"type": "String",
"value": "BRL"
},
{
"displayName": "BWP",
"required": false,
"type": "String",
"value": "BWP"
},
{
"displayName": "CAD",
"required": false,
"type": "String",
"value": "CAD"
},
{
"displayName": "CHF",
"required": false,
"type": "String",
"value": "CHF"
},
{
"displayName": "CLP",
"required": false,
"type": "String",
"value": "CLP"
},
{
"displayName": "CNY",
"required": false,
"type": "String",
"value": "CNY"
},
{
"displayName": "COP",
"required": false,
"type": "String",
"value": "COP"
},
{
"displayName": "CRC",
"required": false,
"type": "String",
"value": "CRC"
},
{
"displayName": "CUC",
"required": false,
"type": "String",
"value": "CUC"
},
{
"displayName": "CUP",
"required": false,
"type": "String",
"value": "CUP"
},
{
"displayName": "CZK",
"required": false,
"type": "String",
"value": "CZK"
},
{
"displayName": "DKK",
"required": false,
"type": "String",
"value": "DKK"
},
{
"displayName": "DOP",
"required": false,
"type": "String",
"value": "DOP"
},
{
"displayName": "EGP",
"required": false,
"type": "String",
"value": "EGP"
},
{
"displayName": "EUR",
"required": false,
"type": "String",
"value": "EUR"
},
{
"displayName": "FJD",
"required": false,
"type": "String",
"value": "FJD"
},
{
"displayName": "GBP",
"required": false,
"type": "String",
"value": "GBP"
},
{
"displayName": "GEL",
"required": false,
"type": "String",
"value": "GEL"
},
{
"displayName": "GHS",
"required": false,
"type": "String",
"value": "GHS"
},
{
"displayName": "GTQ",
"required": false,
"type": "String",
"value": "GTQ"
},
{
"displayName": "GYD",
"required": false,
"type": "String",
"value": "GYD"
},
{
"displayName": "HKD",
"required": false,
"type": "String",
"value": "HKD"
},
{
"displayName": "HNL",
"required": false,
"type": "String",
"value": "HNL"
},
{
"displayName": "HRK",
"required": false,
"type": "String",
"value": "HRK"
},
{
"displayName": "HUF",
"required": false,
"type": "String",
"value": "HUF"
},
{
"displayName": "IDR",
"required": false,
"type": "String",
"value": "IDR"
},
{
"displayName": "ILS",
"required": false,
"type": "String",
"value": "ILS"
},
{
"displayName": "INR",
"required": false,
"type": "String",
"value": "INR"
},
{
"displayName": "ISK",
"required": false,
"type": "String",
"value": "ISK"
},
{
"displayName": "JMD",
"required": false,
"type": "String",
"value": "JMD"
},
{
"displayName": "JPY",
"required": false,
"type": "String",
"value": "JPY"
},
{
"displayName": "KES",
"required": false,
"type": "String",
"value": "KES"
},
{
"displayName": "KRW",
"required": false,
"type": "String",
"value": "KRW"
},
{
"displayName": "KWD",
"required": false,
"type": "String",
"value": "KWD"
},
{
"displayName": "KYD",
"required": false,
"type": "String",
"value": "KYD"
},
{
"displayName": "KZT",
"required": false,
"type": "String",
"value": "KZT"
},
{
"displayName": "LAK",
"required": false,
"type": "String",
"value": "LAK"
},
{
"displayName": "LBP",
"required": false,
"type": "String",
"value": "LBP"
},
{
"displayName": "LKR",
"required": false,
"type": "String",
"value": "LKR"
},
{
"displayName": "LTL",
"required": false,
"type": "String",
"value": "LTL"
},
{
"displayName": "LVL",
"required": false,
"type": "String",
"value": "LVL"
},
{
"displayName": "MAD",
"required": false,
"type": "String",
"value": "MAD"
},
{
"displayName": "MDL",
"required": false,
"type": "String",
"value": "MDL"
},
{
"displayName": "MGA",
"required": false,
"type": "String",
"value": "MGA"
},
{
"displayName": "MUR",
"required": false,
"type": "String",
"value": "MUR"
},
{
"displayName": "MVR",
"required": false,
"type": "String",
"value": "MVR"
},
{
"displayName": "MWK",
"required": false,
"type": "String",
"value": "MWK"
},
{
"displayName": "MXN",
"required": false,
"type": "String",
"value": "MXN"
},
{
"displayName": "MYR",
"required": false,
"type": "String",
"value": "MYR"
},
{
"displayName": "MZN",
"required": false,
"type": "String",
"value": "MZN"
},
{
"displayName": "NAD",
"required": false,
"type": "String",
"value": "NAD"
},
{
"displayName": "NGN",
"required": false,
"type": "String",
"value": "NGN"
},
{
"displayName": "NOK",
"required": false,
"type": "String",
"value": "NOK"
},
{
"displayName": "NPR",
"required": false,
"type": "String",
"value": "NPR"
},
{
"displayName": "NZD",
"required": false,
"type": "String",
"value": "NZD"
},
{
"displayName": "OMR",
"required": false,
"type": "String",
"value": "OMR"
},
{
"displayName": "PEN",
"required": false,
"type": "String",
"value": "PEN"
},
{
"displayName": "PHP",
"required": false,
"type": "String",
"value": "PHP"
},
{
"displayName": "PKR",
"required": false,
"type": "String",
"value": "PKR"
},
{
"displayName": "PLN",
"required": false,
"type": "String",
"value": "PLN"
},
{
"displayName": "QAR",
"required": false,
"type": "String",
"value": "QAR"
},
{
"displayName": "RON",
"required": false,
"type": "String",
"value": "RON"
},
{
"displayName": "RSD",
"required": false,
"type": "String",
"value": "RSD"
},
{
"displayName": "RUB",
"required": false,
"type": "String",
"value": "RUB"
},
{
"displayName": "RWF",
"required": false,
"type": "String",
"value": "RWF"
},
{
"displayName": "SAR",
"required": false,
"type": "String",
"value": "SAR"
},
{
"displayName": "SCR",
"required": false,
"type": "String",
"value": "SCR"
},
{
"displayName": "SEK",
"required": false,
"type": "String",
"value": "SEK"
},
{
"displayName": "SGD",
"required": false,
"type": "String",
"value": "SGD"
},
{
"displayName": "THB",
"required": false,
"type": "String",
"value": "THB"
},
{
"displayName": "TND",
"required": false,
"type": "String",
"value": "TND"
},
{
"displayName": "TRY",
"required": false,
"type": "String",
"value": "TRY"
},
{
"displayName": "TTD",
"required": false,
"type": "String",
"value": "TTD"
},
{
"displayName": "TWD",
"required": false,
"type": "String",
"value": "TWD"
},
{
"displayName": "TZS",
"required": false,
"type": "String",
"value": "TZS"
},
{
"displayName": "UAH",
"required": false,
"type": "String",
"value": "UAH"
},
{
"displayName": "UGX",
"required": false,
"type": "String",
"value": "UGX"
},
{
"displayName": "USD",
"required": false,
"type": "String",
"value": "USD"
},
{
"displayName": "UYU",
"required": false,
"type": "String",
"value": "UYU"
},
{
"displayName": "VEF",
"required": false,
"type": "String",
"value": "VEF"
},
{
"displayName": "VND",
"required": false,
"type": "String",
"value": "VND"
},
{
"displayName": "VUV",
"required": false,
"type": "String",
"value": "VUV"
},
{
"displayName": "XAF",
"required": false,
"type": "String",
"value": "XAF"
},
{
"displayName": "XCD",
"required": false,
"type": "String",
"value": "XCD"
},
{
"displayName": "XOF",
"required": false,
"type": "String",
"value": "XOF"
},
{
"displayName": "ZAR",
"required": false,
"type": "String",
"value": "ZAR"
},
{
"displayName": "ZMK",
"required": false,
"type": "String",
"value": "ZMK"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not specified, defaults to the company's native currency",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the bill and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"dueDate": {
"description": "The date the bill is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime"
},
"issueDate": {
"description": "The date of the bill as recorded in the originating system.",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the bill",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Amount of sales tax for the BillLineItem in company's native currency.",
"field": "LineItems.TaxAmount"
}
],
"warnings": [
{
"details": "Must be positive for bill items and negative for credit items. If not specified, defaults to the tax correct tax rate amount for the category of the bill.",
"field": "LineItems.TaxAmount"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must contain at least one line item and up to a maximum of 40 line items allowed.",
"field": "LineItems"
}
]
}
},
"reference": {
"description": "User friendly reference for the bill",
"displayName": "Reference",
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the bill has been received from",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing supplier.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"taxAmount": {
"description": "The total amount of tax on the bill",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater than or equal to 0, less than or equal to the Bill.TotalAmount and equal to the total value of the bill item tax amounts.",
"field": "TaxAmount"
}
]
}
},
"totalAmount": {
"description": "The amount of the bill, inclusive of tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater than or equal to 0 and must be equal to the total value of the bill item total amounts.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"properties": {
"amountDue": {
"description": "The amount outstanding on the bill",
"displayName": "Amount Due",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be at least zero and no more than that the total amount.",
"field": "AmountDue"
}
],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "AmountDue"
}
]
}
},
"currency": {
"description": "Currency of the bill",
"displayName": "Currency",
"options": [
{
"displayName": "Australian Dollar",
"required": false,
"type": "String",
"value": "AUD"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Currency"
}
],
"warnings": []
}
},
"dueDate": {
"description": "The date the bill is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "DueDate"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The date of the bill as recorded in the originating system.",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must not be before the due date.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the bill",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the Inventory Item's AccountRef if supplied",
"field": "LineItems.AccountRef"
},
{
"details": "Must be supplied except when an ItemRef is supplied",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be greater than 225 characters long.",
"field": "LineItems.Description"
}
],
"warnings": []
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "LineItems.TaxAmount"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TaxRateRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TaxRateRef"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TotalAmount"
}
],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "LineItems.TotalAmount"
}
]
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "LineItems.UnitAmount"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"reference": {
"description": "User friendly reference for the bill",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be greater than 8 characters long.",
"field": "Reference"
}
],
"warnings": []
}
},
"subTotal": {
"description": "The total amount of the bill excluding any taxes",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "SubTotal"
}
]
}
},
"supplierRef": {
"description": "Reference to the supplier the bill has been received from",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The total amount of tax on the bill",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "TaxAmount"
}
]
}
},
"totalAmount": {
"description": "The amount of the bill, inclusive of tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "TotalAmount"
},
{
"details": "Must be greater than zero.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"options": [
{
"displayName": "Open",
"required": false,
"type": "String",
"value": "Open"
}
],
"properties": {
"currency": {
"description": "Currency of the bill",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the bill and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"dueDate": {
"description": "The date the bill is due to be paid by",
"displayName": "Due Date",
"required": false,
"type": "DateTime"
},
"issueDate": {
"description": "The date of the bill as recorded in the originating system.",
"displayName": "Issue Date",
"required": false,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the bill",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Should only be specified when pushing an expense",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Should only be specified when pushing an item (not an expense)",
"field": "ItemRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"tracking": {
"description": "A collection of items this line item is being tracked against",
"displayName": "Accounts Payable Tracking",
"properties": {
"categoryRefs": {
"description": "A collection of categories this line item is being tracked against",
"displayName": "Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
}
},
"required": false,
"type": "Object"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the bill",
"displayName": "Note",
"required": false,
"type": "String"
},
"reference": {
"description": "User friendly reference for the bill",
"displayName": "Reference",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the bill",
"displayName": "Bill Status",
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the bill has been received from",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"properties": {
"currency": {
"description": "Currency of the bill",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the default currency of the supplier",
"field": "Currency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code that matches the currency of the supplier",
"field": "Currency"
},
{
"details": "Can only be set if the QuickBooks Desktop company has Multicurrency enabled.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the bill and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.",
"field": "CurrencyRate"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"dueDate": {
"description": "The date the bill is due to be paid by",
"displayName": "Due Date",
"required": false,
"type": "DateTime"
},
"issueDate": {
"description": "The date of the bill as recorded in the originating system.",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the bill",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing nominal account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Account type must be Asset, Liability or Expense and not Accounts Payable",
"field": "LineItems.AccountRef"
}
],
"warnings": [
{
"details": "Can't include both AccountRef and ItemRef",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing item type.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Item type must not be Discount or Sale-Tax items",
"field": "LineItems.ItemRef"
}
],
"warnings": [
{
"details": "Can't include both AccountRef and ItemRef",
"field": "LineItems.ItemRef"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must match quantity * unit amount of line",
"field": "LineItems.SubTotal"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Cannot be mapped directly into QuickBooks Desktop and will only be used for validation purposes",
"field": "LineItems.TaxAmount"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only valid for UK or CA versions of QuickBooks Desktop with VAT enabled",
"field": "TaxRateRef.Id"
},
{
"details": "Must match the ID of an existing tax rate",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must match subtotal + tax amount of line",
"field": "LineItems.TotalAmount"
}
],
"warnings": []
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tracking category.",
"field": "TrackingCategoryRefs.Id"
}
]
}
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the bill",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4000 characters.",
"field": "Note"
}
]
}
},
"paymentAllocations": {
"description": "A collection of payments allocated to the bill",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "If set, must match issue date on the bill",
"field": "Allocation.AllocatedOnDate"
}
]
}
},
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "If set, must match currency on the bill",
"field": "Allocation.Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the transaction",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "If set, must match currency rate on the bill",
"field": "Allocation.CurrencyRate"
}
]
}
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match total amount on the bill",
"field": "Allocation.TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing credit card account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": " Account type must be of type Credit Card",
"field": "Payment.AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "$ set, must match currency on the {topLevelItem}",
"field": "Payment.Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "If set, must match currency rate on the bill",
"field": "Payment.CurrencyRate"
}
]
}
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match issue date on the bill",
"field": "Payment.PaidOnDate"
}
]
}
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": " Must match total amount on the bill",
"field": "Payment.TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "If a payment allocation is provided, a credit card charge will created in QuickBooksDesktop, if left as null or empty, a {topLevelItem} will be created",
"field": "PaymentAllocations"
}
],
"warnings": [
{
"details": "A maximum of one payment allocation may be provided per bill",
"field": "PaymentAllocations"
}
]
}
},
"reference": {
"description": "User friendly reference for the bill",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 20 characters.",
"field": "Reference"
}
]
}
},
"status": {
"description": "The current state of the bill",
"displayName": "Bill Status",
"options": [
{
"displayName": "Open",
"required": false,
"type": "String",
"value": "Open"
},
{
"displayName": "Paid",
"required": false,
"type": "String",
"value": "Paid"
},
{
"displayName": "Void",
"required": false,
"type": "String",
"value": "Void"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If a bill is pushed with a status of void, then all the amounts in the bill must be 0",
"field": "Status"
},
{
"details": "If a bill is pushed without payment allocations, then the status must be Open, if pushed with payment allocations, then the status must be paid",
"field": "Status"
}
],
"warnings": [
{
"details": "If a bill is pushed with a total amount of 0, then the status must be Paid or Void",
"field": "Status"
}
]
}
},
"subTotal": {
"description": "The total amount of the bill excluding any taxes",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the totalAmount - taxAmount",
"field": "SubTotal"
}
]
}
},
"supplierRef": {
"description": "Reference to the supplier the bill has been received from",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing supplier.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"taxAmount": {
"description": "The total amount of tax on the bill",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Cannot be mapped directly into QuickBooks Desktop and will only be used for validation purposes",
"field": "TaxAmount"
},
{
"details": "Must match sum of total of tax from the line items",
"field": "TaxAmount"
}
]
}
},
"totalAmount": {
"description": "The amount of the bill, inclusive of tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "If a bill is pushed with a total amount of 0, it will automatically be marked as paid in QuickBooks Desktop",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Must match the sum of line items ((quantity * unit price) - discount + tax)",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"properties": {
"currency": {
"description": "Currency of the bill",
"displayName": "Currency",
"options": [
{
"displayName": "USD",
"required": false,
"type": "String",
"value": "USD"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the bill and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if Currency is not the base currency.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"dueDate": {
"description": "The date the bill is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime"
},
"issueDate": {
"description": "The date of the bill as recorded in the originating system.",
"displayName": "Issue Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "If the issue date is not supplied, the current date on the server is used.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the bill",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Required if the expense line is account based. If AccountRef is specified, ItemRef must be null.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not be longer than 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Required if the expense line is item based. If ItemRef is specified, AccountRef must be null.",
"field": "ItemRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used, or the tax rate must be unset.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax code.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"tracking": {
"description": "A collection of items this line item is being tracked against",
"displayName": "Accounts Payable Tracking",
"properties": {
"customerRef": {
"description": "Reference to the customer this line item is being tracked against",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"isRebilledTo": {
"description": "The type of item this line item is billed to",
"displayName": "Is Rebilled To",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be set to 'Customer' when Tracking.CustomerRef is supplied",
"field": "Tracking.IsRebilledTo"
}
]
}
}
},
"required": false,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tracking category and be of type DEPARTMENT or CLASS.",
"field": "TrackingCategoryRefs.Id"
}
]
}
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the bill",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the bill",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Payment Allocations are no longer valid for Bills and must not be provided, use the DirectCost data type to push Expenses.",
"field": "PaymentAllocations"
}
]
}
},
"reference": {
"description": "User friendly reference for the bill",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Should be unique if WarnDuplicateBillNumber setting is On.",
"field": "Reference"
},
{
"details": "Should not be longer than 21 characters.",
"field": "Reference"
}
],
"warnings": []
}
},
"subTotal": {
"description": "The total amount of the bill excluding any taxes",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"supplierRef": {
"description": "Reference to the supplier the bill has been received from",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The amount of the bill, inclusive of tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"properties": {
"currency": {
"description": "The currency in which the bill is issued in.",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "This must match the supplier's default currency.",
"field": "currency"
}
]
}
},
"dueDate": {
"description": "Date when the bill is due.",
"displayName": "Due Date",
"required": true,
"type": "DateTime"
},
"issueDate": {
"description": "Date when the bill was issued.",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "Line items of the bill.",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Identifier for the account.",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "Identifier of the account.",
"displayName": "Account Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "accountRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Description of the bill line item.",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 60 characters.",
"field": "lineItems.description"
}
]
}
},
"taxAmount": {
"description": "Tax of the bill line item.",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Tax rate reference of a bill line item.",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "ID of the tax rate.",
"displayName": "Tax Rate Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tax rate.",
"field": "taxRateRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the bill line item, inclusive of the tax amount.",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"trackingCategoryRefs": {
"description": "Tracking categories for the line item",
"displayName": "Tracking Categories",
"properties": {
"id": {
"description": "Prefixed identifier for tracking category e.g. project_{x}, department_{x}, costcode_{x}",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Cost codes assigned with costcode_{x} must exist in Sage50 and must be assigned in conjunction with a project",
"field": "trackingCategoryRefs.id"
},
{
"details": "Projects assigned with project_{x} must exist in Sage50 and must be assigned in conjunction with a cost code",
"field": "trackingCategoryRefs.id"
},
{
"details": "Departments assigned with department_{x} must exist in Sage50",
"field": "trackingCategoryRefs.id"
}
]
}
}
},
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "To be used for any additional information associated with the Bill line item.",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Maximum 60 characters",
"field": "note"
}
]
}
},
"reference": {
"description": "The reference to the bill.",
"displayName": "Bill Reference",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 30 characters.",
"field": "reference"
}
]
}
},
"status": {
"description": "The status of the bill",
"displayName": "Status",
"options": [
{
"displayName": "Open",
"required": false,
"type": "String",
"value": "Open"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If this is not set, it will default to 'Open'.",
"field": "status"
}
],
"warnings": []
}
},
"supplierRef": {
"description": "Supplier on the bill.",
"displayName": "Supplier",
"properties": {
"id": {
"description": "Identifier of the supplier.",
"displayName": "Supplier Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing supplier and have a max length of 8 characters.",
"field": "supplierRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"properties": {
"currency": {
"description": "Currency of the bill",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If supplied, must match the currency of the supplier.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the bill and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"dueDate": {
"description": "The date the bill is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "DueDate"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The date of the bill as recorded in the originating system.",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the bill",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Description"
}
],
"warnings": [
{
"details": "Should not be longer than 2000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If ItemRef is provided, then ID is required.",
"field": "ItemRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TaxAmount"
}
],
"warnings": []
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax code.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the bill",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not be longer than 2000 characters.",
"field": "Note"
}
]
}
},
"reference": {
"description": "User friendly reference for the bill",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not be longer than 25 characters.",
"field": "Reference"
}
]
}
},
"supplierRef": {
"description": "Reference to the supplier the bill has been received from",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing supplier.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"properties": {
"currency": {
"description": "Currency of the bill",
"displayName": "Currency",
"options": [
{
"displayName": "Australian Dollar",
"required": false,
"type": "String",
"value": "AUD"
},
{
"displayName": "Canadian Dollar",
"required": false,
"type": "String",
"value": "CAD"
},
{
"displayName": "Pound Sterling",
"required": false,
"type": "String",
"value": "GBP"
},
{
"displayName": "US Dollar",
"required": false,
"type": "String",
"value": "USD"
},
{
"displayName": "Rand",
"required": false,
"type": "String",
"value": "ZAR"
}
],
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if CurrencyRate is set.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the bill and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater than 0.",
"field": "CurrencyRate"
}
]
}
},
"dueDate": {
"description": "The date the bill is due to be paid by",
"displayName": "Due Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "For item based line items, must be provided and must not be earlier than IssueDate.",
"field": "DueDate"
}
]
}
},
"id": {
"description": "The identifier for the bill, unique for the company",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Not supported for account based line items. Required for item based line items. A unique number for the bill will be appended to the value supplied, to ensure the ID is unique.",
"field": "Id"
}
]
}
},
"issueDate": {
"description": "The date of the bill as recorded in the originating system.",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the bill",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match to an existing Account Id.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided for account based line items. Must not be provided for item based line items.",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "For account based line items, must be between 1 and 1000 characters. For item based line items, must be between 1 and 400 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match to an existing Item Id.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided for item based line items. Must not be provided for account based line items.",
"field": "LineItems.ItemRef"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "For item based line items, must be provided and must not be negative. For account based line items, if provided must always be 0.",
"field": "LineItems.Quantity"
}
]
}
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided for account based line items. Must not be provided for item based line items.",
"field": "LineItems.SubTotal"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match to an existing TaxRate Id.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Is not supported for item based line items.",
"field": "LineItems.TaxRateRef"
}
]
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must contain the type of the tracking category and the Id of the selected category, separated by a '-'. For example, 'DEPARTMENT-100'.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "Custom tracking categories are only supported for account based line items.",
"field": "TrackingCategoryRefs.Id"
}
]
}
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "For item based line items, must be provided and must not be negative. For account based line items, if provided must always be 0.",
"field": "LineItems.UnitAmount"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must either all be account based or all be item based.",
"field": "LineItems"
}
]
}
},
"note": {
"description": "Note about the bill",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Is not supported for item based line items.",
"field": "Note"
}
]
}
},
"reference": {
"description": "User friendly reference for the bill",
"displayName": "Reference",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "For account based line items, must be between 1 and 100 characters. For item based line items, must be between 1 and 45 characters.",
"field": "Reference"
}
]
}
},
"status": {
"description": "The current state of the bill",
"displayName": "Bill Status",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided for item based line items.",
"field": "Status"
}
]
}
},
"supplierRef": {
"description": "Reference to the supplier the bill has been received from",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match to an existing Supplier Id.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"properties": {
"amountDue": {
"description": "The amount outstanding on the bill",
"displayName": "Amount Due",
"required": true,
"type": "Number"
},
"currency": {
"description": "Currency of the bill",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the bill and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"dueDate": {
"description": "The date the bill is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime"
},
"issueDate": {
"description": "The date of the bill as recorded in the originating system.",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the bill",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String"
},
"discountAmount": {
"description": "The value, in the given bill currency, of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"isDirectCost": {
"description": "True if this bill is also mapped as a direct cost",
"displayName": "Is Direct Cost",
"required": true,
"type": "Boolean"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the item referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"tracking": {
"description": "A collection of items this line item is being tracked against",
"displayName": "Accounts Payable Tracking",
"properties": {
"categoryRefs": {
"description": "A collection of categories this line item is being tracked against",
"displayName": "Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"customerRef": {
"description": "Reference to the customer this line item is being tracked against",
"displayName": "Customer Reference",
"properties": {
"companyName": {
"description": "The name of the customer referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"isBilledTo": {
"description": "The type of item this line item is billed to.",
"displayName": "Is Billed To",
"required": true,
"type": "String"
},
"isRebilledTo": {
"description": "The type of item this line item is billed to",
"displayName": "Is Rebilled To",
"required": true,
"type": "String"
},
"projectRef": {
"description": "Reference to the project this line item is being tracked against",
"displayName": "Project Reference",
"properties": {
"id": {
"description": "The reference identifier for the Project",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the Project referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"note": {
"description": "Note about the bill",
"displayName": "Note",
"required": true,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the bill",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the transaction",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the allocated payment",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"note": {
"description": "Any additional text based information associated with the allocated payment",
"displayName": "Note",
"required": true,
"type": "String"
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime"
},
"reference": {
"description": "Reference associated with the allocated payment",
"displayName": "Reference",
"required": true,
"type": "String"
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array"
},
"purchaseOrderRefs": {
"description": "List of References to the purchase order the bill was created from.",
"displayName": "Purchase Order References",
"properties": {
"id": {
"description": "Unique identifier for the purchase order in the accounting platform",
"displayName": "Id",
"required": true,
"type": "String"
},
"purchaseOrderNumber": {
"description": "Friendly reference for the purchase order, commonly generated by the accounting platform",
"displayName": "Purchase Order Number",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"reference": {
"description": "User friendly reference for the bill",
"displayName": "Reference",
"required": true,
"type": "String"
},
"status": {
"description": "The current state of the bill",
"displayName": "Bill Status",
"required": true,
"type": "String"
},
"subTotal": {
"description": "The total amount of the bill excluding any taxes",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"supplierRef": {
"description": "Reference to the supplier the bill has been received from",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"supplierName": {
"description": "The name of the supplier referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"taxAmount": {
"description": "The total amount of tax on the bill",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The amount of the bill, inclusive of tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"withholdingTax": {
"description": "A collection of tax deductions",
"displayName": "Withholding Tax",
"properties": {
"amount": {
"description": "Deduction amount",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"name": {
"description": "Name of the deduction",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"properties": {
"currency": {
"description": "Currency of the bill",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the bill and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If no rate is specified, the Xero day rate will be applied.",
"field": "CurrencyRate",
"ref": "https://central.xero.com/s/#CurrencySettings$Rates"
}
],
"warnings": []
}
},
"dueDate": {
"description": "The date the bill is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "DueDate"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The date of the bill as recorded in the originating system.",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the bill",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided, if ItemRef is not provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided, if ItemRef is not provided.",
"field": "LineItems.AccountRef"
}
],
"warnings": []
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 4000 characters long.",
"field": "LineItems.Description"
}
],
"warnings": []
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "ItemRef.Id"
},
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided, if AccountRef is not provided.",
"field": "LineItems.ItemRef"
}
],
"warnings": []
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Cannot be mapped directly into Xero and will only be used for validation purposes.",
"field": "LineItems.TaxAmount"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided if TaxAmount is provided.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "TaxRateRef.Id"
},
{
"details": "Must match the ID of an existing tax rate.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be a parent tracking category.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "Must be provided.",
"field": "TrackingCategoryRefs.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Tracking categories must not have the same parent tracking category.",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "Maximum of 2 Tracking Categories.",
"field": "LineItems.TrackingCategoryRefs"
}
],
"warnings": []
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"reference": {
"description": "User friendly reference for the bill",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not exceed 255 charaters long.",
"field": "Reference"
}
],
"warnings": []
}
},
"status": {
"description": "The current state of the bill",
"displayName": "Bill Status",
"options": [
{
"displayName": "Open",
"required": false,
"type": "String",
"value": "Open"
},
{
"displayName": "Draft",
"required": false,
"type": "String",
"value": "Draft"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Status"
}
],
"warnings": []
}
},
"supplierRef": {
"description": "Reference to the supplier the bill has been received from",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "SupplierRef.Id"
},
{
"details": "Must match the ID of an existing customer.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "SupplierRef"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A bill is an itemised record of goods purchased from or services provided by a supplier",
"displayName": "Bill",
"properties": {
"currency": {
"description": "Currency of the bill",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the supplier's currency",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the bill and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater than or equal to 0",
"field": "CurrencyRate"
}
]
}
},
"dueDate": {
"description": "The date the bill is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime"
},
"issueDate": {
"description": "The date of the bill as recorded in the originating system.",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the bill",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if ItemRef is not set",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String"
},
"discountAmount": {
"description": "The value, in the given bill currency, of any discounts applied",
"displayName": "Discount Amount",
"required": false,
"type": "Number"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if AccountRef is not set",
"field": "LineItems.ItemRef"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "The sum of subtotals over all the line items must be greater than or equal to 0",
"field": "LineItems"
},
{
"details": "Must not be empty",
"field": "LineItems"
}
]
}
},
"note": {
"description": "Note about the bill",
"displayName": "Note",
"required": false,
"type": "String"
},
"reference": {
"description": "User friendly reference for the bill",
"displayName": "Reference",
"required": true,
"type": "String"
},
"status": {
"description": "The current state of the bill",
"displayName": "Bill Status",
"options": [
{
"displayName": "Open",
"required": false,
"type": "String",
"value": "Open"
},
{
"displayName": "Void",
"required": false,
"type": "String",
"value": "Void"
}
],
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Reference to the supplier the bill has been received from",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}
GET
List bill attachments
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachmentshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachmentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachmentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List bills
{{baseUrl}}/companies/:companyId/data/bills
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/bills?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/bills" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/bills?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/bills?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/bills?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/bills?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/bills?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/bills?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/bills?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/bills?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/bills?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/bills?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bills',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/bills?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/bills?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/bills?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/bills?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bills',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/bills');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/bills',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/bills?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/bills?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/bills?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/bills?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/bills?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/bills');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/bills');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/bills?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/bills?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/bills?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/bills"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/bills"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/bills?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/bills') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/bills";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/bills?page='http GET '{{baseUrl}}/companies/:companyId/data/bills?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/bills?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/bills?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Update bill
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"
payload = {}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId"
payload <- "{}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http PUT {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billIdimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Upload bill attachments
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments"
response = HTTP::Client.post url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments")
.post(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments")
.post(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments' -Method POST $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments' -Method POST import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments"
response = requests.post(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachmentshttp POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachmentswget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachmentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/bills/:billId/attachments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get company info
{{baseUrl}}/companies/:companyId/data/info
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/info");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/info")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/info"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/info"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/info");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/info"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/info HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/info")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/info"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/info")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/info")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/info');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/info'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/info';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/info',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/info")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/info',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/info'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/info');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/info'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/info';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/info"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/info" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/info",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/info');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/info');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/info');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/info' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/info' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/info")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/info"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/info"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/info")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/info') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/info";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/infohttp GET {{baseUrl}}/companies/:companyId/data/infowget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/infoimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/info")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Refresh company info
{{baseUrl}}/companies/:companyId/data/info
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/info");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/data/info")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/info"
response = HTTP::Client.post url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/info"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/info");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/info"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/data/info HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/data/info")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/info"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/info")
.post(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/data/info")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/data/info');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/data/info'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/info';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/info',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/info")
.post(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/info',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/data/info'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/data/info');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/data/info'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/info';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/info"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/info" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/info",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/data/info');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/info');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/info');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/info' -Method POST $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/info' -Method POST import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/companies/:companyId/data/info")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/info"
response = requests.post(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/info"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/info")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/companies/:companyId/data/info') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/info";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/data/infohttp POST {{baseUrl}}/companies/:companyId/data/infowget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/companies/:companyId/data/infoimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/info")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create credit note
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/creditNotes HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/creditNotes',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/creditNotes", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/creditNotes') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotesimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create-update credit note model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/creditNotes HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/creditNotes',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/creditNotes")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/creditNotes') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNoteshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNoteswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/creditNotes")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.",
"displayName": "Accounts Receivable Credit Note",
"properties": {
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"options": [
{
"displayName": "AED",
"required": false,
"type": "String",
"value": "AED"
},
{
"displayName": "AMD",
"required": false,
"type": "String",
"value": "AMD"
},
{
"displayName": "AOA",
"required": false,
"type": "String",
"value": "AOA"
},
{
"displayName": "ARS",
"required": false,
"type": "String",
"value": "ARS"
},
{
"displayName": "AUD",
"required": false,
"type": "String",
"value": "AUD"
},
{
"displayName": "AWG",
"required": false,
"type": "String",
"value": "AWG"
},
{
"displayName": "AZN",
"required": false,
"type": "String",
"value": "AZN"
},
{
"displayName": "BBD",
"required": false,
"type": "String",
"value": "BBD"
},
{
"displayName": "BDT",
"required": false,
"type": "String",
"value": "BDT"
},
{
"displayName": "BGN",
"required": false,
"type": "String",
"value": "BGN"
},
{
"displayName": "BRL",
"required": false,
"type": "String",
"value": "BRL"
},
{
"displayName": "BWP",
"required": false,
"type": "String",
"value": "BWP"
},
{
"displayName": "CAD",
"required": false,
"type": "String",
"value": "CAD"
},
{
"displayName": "CHF",
"required": false,
"type": "String",
"value": "CHF"
},
{
"displayName": "CLP",
"required": false,
"type": "String",
"value": "CLP"
},
{
"displayName": "CNY",
"required": false,
"type": "String",
"value": "CNY"
},
{
"displayName": "COP",
"required": false,
"type": "String",
"value": "COP"
},
{
"displayName": "CRC",
"required": false,
"type": "String",
"value": "CRC"
},
{
"displayName": "CUC",
"required": false,
"type": "String",
"value": "CUC"
},
{
"displayName": "CUP",
"required": false,
"type": "String",
"value": "CUP"
},
{
"displayName": "CZK",
"required": false,
"type": "String",
"value": "CZK"
},
{
"displayName": "DKK",
"required": false,
"type": "String",
"value": "DKK"
},
{
"displayName": "DOP",
"required": false,
"type": "String",
"value": "DOP"
},
{
"displayName": "EGP",
"required": false,
"type": "String",
"value": "EGP"
},
{
"displayName": "EUR",
"required": false,
"type": "String",
"value": "EUR"
},
{
"displayName": "FJD",
"required": false,
"type": "String",
"value": "FJD"
},
{
"displayName": "GBP",
"required": false,
"type": "String",
"value": "GBP"
},
{
"displayName": "GEL",
"required": false,
"type": "String",
"value": "GEL"
},
{
"displayName": "GHS",
"required": false,
"type": "String",
"value": "GHS"
},
{
"displayName": "GTQ",
"required": false,
"type": "String",
"value": "GTQ"
},
{
"displayName": "GYD",
"required": false,
"type": "String",
"value": "GYD"
},
{
"displayName": "HKD",
"required": false,
"type": "String",
"value": "HKD"
},
{
"displayName": "HNL",
"required": false,
"type": "String",
"value": "HNL"
},
{
"displayName": "HRK",
"required": false,
"type": "String",
"value": "HRK"
},
{
"displayName": "HUF",
"required": false,
"type": "String",
"value": "HUF"
},
{
"displayName": "IDR",
"required": false,
"type": "String",
"value": "IDR"
},
{
"displayName": "ILS",
"required": false,
"type": "String",
"value": "ILS"
},
{
"displayName": "INR",
"required": false,
"type": "String",
"value": "INR"
},
{
"displayName": "ISK",
"required": false,
"type": "String",
"value": "ISK"
},
{
"displayName": "JMD",
"required": false,
"type": "String",
"value": "JMD"
},
{
"displayName": "JPY",
"required": false,
"type": "String",
"value": "JPY"
},
{
"displayName": "KES",
"required": false,
"type": "String",
"value": "KES"
},
{
"displayName": "KRW",
"required": false,
"type": "String",
"value": "KRW"
},
{
"displayName": "KWD",
"required": false,
"type": "String",
"value": "KWD"
},
{
"displayName": "KYD",
"required": false,
"type": "String",
"value": "KYD"
},
{
"displayName": "KZT",
"required": false,
"type": "String",
"value": "KZT"
},
{
"displayName": "LAK",
"required": false,
"type": "String",
"value": "LAK"
},
{
"displayName": "LBP",
"required": false,
"type": "String",
"value": "LBP"
},
{
"displayName": "LKR",
"required": false,
"type": "String",
"value": "LKR"
},
{
"displayName": "LTL",
"required": false,
"type": "String",
"value": "LTL"
},
{
"displayName": "LVL",
"required": false,
"type": "String",
"value": "LVL"
},
{
"displayName": "MAD",
"required": false,
"type": "String",
"value": "MAD"
},
{
"displayName": "MDL",
"required": false,
"type": "String",
"value": "MDL"
},
{
"displayName": "MGA",
"required": false,
"type": "String",
"value": "MGA"
},
{
"displayName": "MUR",
"required": false,
"type": "String",
"value": "MUR"
},
{
"displayName": "MVR",
"required": false,
"type": "String",
"value": "MVR"
},
{
"displayName": "MWK",
"required": false,
"type": "String",
"value": "MWK"
},
{
"displayName": "MXN",
"required": false,
"type": "String",
"value": "MXN"
},
{
"displayName": "MYR",
"required": false,
"type": "String",
"value": "MYR"
},
{
"displayName": "MZN",
"required": false,
"type": "String",
"value": "MZN"
},
{
"displayName": "NAD",
"required": false,
"type": "String",
"value": "NAD"
},
{
"displayName": "NGN",
"required": false,
"type": "String",
"value": "NGN"
},
{
"displayName": "NOK",
"required": false,
"type": "String",
"value": "NOK"
},
{
"displayName": "NPR",
"required": false,
"type": "String",
"value": "NPR"
},
{
"displayName": "NZD",
"required": false,
"type": "String",
"value": "NZD"
},
{
"displayName": "OMR",
"required": false,
"type": "String",
"value": "OMR"
},
{
"displayName": "PEN",
"required": false,
"type": "String",
"value": "PEN"
},
{
"displayName": "PHP",
"required": false,
"type": "String",
"value": "PHP"
},
{
"displayName": "PKR",
"required": false,
"type": "String",
"value": "PKR"
},
{
"displayName": "PLN",
"required": false,
"type": "String",
"value": "PLN"
},
{
"displayName": "QAR",
"required": false,
"type": "String",
"value": "QAR"
},
{
"displayName": "RON",
"required": false,
"type": "String",
"value": "RON"
},
{
"displayName": "RSD",
"required": false,
"type": "String",
"value": "RSD"
},
{
"displayName": "RUB",
"required": false,
"type": "String",
"value": "RUB"
},
{
"displayName": "RWF",
"required": false,
"type": "String",
"value": "RWF"
},
{
"displayName": "SAR",
"required": false,
"type": "String",
"value": "SAR"
},
{
"displayName": "SCR",
"required": false,
"type": "String",
"value": "SCR"
},
{
"displayName": "SEK",
"required": false,
"type": "String",
"value": "SEK"
},
{
"displayName": "SGD",
"required": false,
"type": "String",
"value": "SGD"
},
{
"displayName": "THB",
"required": false,
"type": "String",
"value": "THB"
},
{
"displayName": "TND",
"required": false,
"type": "String",
"value": "TND"
},
{
"displayName": "TRY",
"required": false,
"type": "String",
"value": "TRY"
},
{
"displayName": "TTD",
"required": false,
"type": "String",
"value": "TTD"
},
{
"displayName": "TWD",
"required": false,
"type": "String",
"value": "TWD"
},
{
"displayName": "TZS",
"required": false,
"type": "String",
"value": "TZS"
},
{
"displayName": "UAH",
"required": false,
"type": "String",
"value": "UAH"
},
{
"displayName": "UGX",
"required": false,
"type": "String",
"value": "UGX"
},
{
"displayName": "USD",
"required": false,
"type": "String",
"value": "USD"
},
{
"displayName": "UYU",
"required": false,
"type": "String",
"value": "UYU"
},
{
"displayName": "VEF",
"required": false,
"type": "String",
"value": "VEF"
},
{
"displayName": "VND",
"required": false,
"type": "String",
"value": "VND"
},
{
"displayName": "VUV",
"required": false,
"type": "String",
"value": "VUV"
},
{
"displayName": "XAF",
"required": false,
"type": "String",
"value": "XAF"
},
{
"displayName": "XCD",
"required": false,
"type": "String",
"value": "XCD"
},
{
"displayName": "XOF",
"required": false,
"type": "String",
"value": "XOF"
},
{
"displayName": "ZAR",
"required": false,
"type": "String",
"value": "ZAR"
},
{
"displayName": "ZMK",
"required": false,
"type": "String",
"value": "ZMK"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not specified, defaults to the company's native currency",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"customerRef": {
"description": "Reference to the customer the credit note has been issued to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line item",
"properties": {
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": true,
"type": "String"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If supplied, must be a positive number",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"subTotal": {
"description": "The amount of the credit note, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If supplied, must match the sum of all line items",
"field": "TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.",
"displayName": "Accounts Receivable Credit Note",
"properties": {
"creditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": false,
"type": "String"
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": false,
"type": "String"
},
"customerRef": {
"description": "Reference to the customer the credit note has been issued to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be valid Customer Id",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line item",
"properties": {
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"required": false,
"type": "Object"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": false,
"type": "Array"
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.",
"displayName": "Accounts Receivable Credit Note",
"properties": {
"creditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 13 characters",
"field": "CreditNoteNumber"
}
]
}
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"options": [
{
"displayName": "Australian Dollar",
"required": false,
"type": "String",
"value": "AUD"
}
],
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater than zero.",
"field": "CurrencyRate"
},
{
"details": "Only valid if Currency is set",
"field": "CurrencyRate"
}
]
}
},
"customerRef": {
"description": "Reference to the customer the credit note has been issued to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line item",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be supplied with an inventory item",
"field": "LineItems.AccountRef"
},
{
"details": "Must be supplied except when an ItemRef is supplied",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"trackingCategoryRefs": {
"description": "A collection of categories ths item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have the same value for all line items",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "May contain a maximum of 1 item",
"field": "LineItems.TrackingCategoryRefs"
}
]
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater or equal to 0",
"field": "LineItems.UnitAmount"
}
]
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 2000 characters",
"field": "Note"
}
]
}
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String"
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of TotalAmounts for the line items",
"field": "TotalAmount"
},
{
"details": "Must be greater than zero.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.",
"displayName": "Accounts Receivable Credit Note",
"properties": {
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": false,
"type": "String"
},
"customerRef": {
"description": "Reference to the customer the credit note has been issued to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line item",
"properties": {
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be provided for 'Discount' type items",
"field": "LineItems.Quantity"
}
]
}
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if and only if item does not have type 'Discount'",
"field": "LineItems.SubTotal"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": false,
"type": "Number"
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if item does not have type 'Discount'",
"field": "LineItems.TaxRateRef"
}
]
}
},
"trackingCategoryRefs": {
"description": "A collection of categories ths item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "A single location tracking category must be present on all LineItems. Optionally, a single class tracking category and a single department tracking category may be present on all LineItems too.",
"field": "TrackingCategoryRefs.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be provided for 'Discount' type items",
"field": "LineItems.UnitAmount"
}
]
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.",
"displayName": "Accounts Receivable Credit Note",
"properties": {
"creditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 11 characters.",
"field": "CreditNoteNumber"
}
]
}
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the default currency of the customer",
"field": "Currency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code that matches the currency of the customer",
"field": "Currency"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.",
"field": "CurrencyRate"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"customerRef": {
"description": "Reference to the customer the credit note has been issued to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing customer.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line item",
"properties": {
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "LineItems.ItemRef"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "For US versions of QuickBooks Desktop this must be a Tax Code",
"field": "TaxRateRef.Id"
},
{
"details": "For US versions of QuickBooks Desktop either 'Id' or 'Name' must be specified",
"field": "TaxRateRef.Id"
}
]
}
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "For US versions of QuickBooks Desktop with Sales Tax enabled this must be either 'Tax' or 'Non'",
"field": "TaxRateRef.Name"
},
{
"details": "For US versions of QuickBooks Desktop either 'Id' or 'Name' must be specified",
"field": "TaxRateRef.Name"
}
]
}
}
},
"required": false,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories ths item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tracking category.",
"field": "TrackingCategoryRefs.Id"
}
]
}
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4000 characters.",
"field": "Note"
}
]
}
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.",
"displayName": "Accounts Receivable Credit Note",
"properties": {
"creditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": false,
"type": "String"
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if Currency is not the base currency.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"customerRef": {
"description": "Reference to the customer the credit note has been issued to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing customer.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": false,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line item",
"properties": {
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Description"
}
],
"warnings": [
{
"details": "Maximum character length should not be longer than 4000.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If an organisation has Automated Sales Tax enabled for US locales, then 'TAX' (Automated Sales Tax), 'NON' (no tax) or a custom tax rate can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used.",
"field": "TaxRateRef.Id"
},
{
"details": "Must be provided.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax code.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TotalAmount"
}
],
"warnings": []
}
},
"trackingCategoryRefs": {
"description": "A collection of categories ths item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "A tracking category of type CLASS can only be provided if ClassTrackingPerTxnLine is enabled for the QBO company.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "Only one tracking category of type CLASS can be provided per item.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "A tracking category of type DEPARTMENT should be declared at the top level item (first line item).",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "A tracking category of type DEPARTMENT can only be provided if TrackDepartments is enabled for the QBO company.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "Only one tracking category of type DEPARTMENT can be provided per credit note.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "Must match the ID of an existing tracking category and be of type DEPARTMENT or CLASS.",
"field": "TrackingCategoryRefs.Id"
}
]
}
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String"
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
},
"totalTaxAmount": {
"description": "The amount of tax for the credit note",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Tax will not be overridden if TotalTaxAmount is 0.",
"field": "TotalTaxAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Automated Sales Tax is disabled for this company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.",
"displayName": "Accounts Receivable Credit Note",
"properties": {
"creditNoteNumber": {
"description": "The reference number for this credit note",
"displayName": "Credit Note Number",
"required": true,
"type": "String"
},
"customerRef": {
"description": "Customer to be pay.",
"displayName": "Customer",
"properties": {
"id": {
"description": "Identifier of the customer.",
"displayName": "Customer Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing customer and have a max length of 8 characters.",
"field": "customerRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"lineItems": {
"description": "Line items of the credit note.",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Identifier for the account.",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "Identifier of the account.",
"displayName": "Account Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "accountRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"taxRateRef": {
"description": "Tax rate reference of a credit note line item.",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "ID of the tax rate.",
"displayName": "Tax Rate Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tax rate.",
"field": "taxRateRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "Tracking categories for the line item",
"displayName": "Tracking Categories",
"properties": {
"id": {
"description": "Prefixed identifier for tracking category e.g. project_{x}, department_{x}",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Projects assigned with project_{x} must exist in Sage50",
"field": "trackingCategoryRefs.id"
},
{
"details": "Departments assigned with department_{x} must exist in Sage50",
"field": "trackingCategoryRefs.id"
}
]
}
}
},
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "To be used for any additional information associated with the credit note.",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Maximum 60 characters",
"field": "note"
}
]
}
},
"status": {
"description": "The status of the credit note",
"displayName": "Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If this is not set, it will default to 'Submitted'.",
"field": "status"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.",
"displayName": "Accounts Receivable Credit Note",
"properties": {
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If supplied, must match the currency of the customer.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"customerRef": {
"description": "Reference to the customer the credit note has been issued to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing customer.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line item",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Description"
}
],
"warnings": [
{
"details": "Should not be longer than 2000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TaxAmount"
}
],
"warnings": []
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax rate.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If supplied, must match the total of the line including tax.",
"field": "LineItems.TotalAmount"
}
],
"warnings": []
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Should not be longer than 2000 characters.",
"field": "Note"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If supplied, must match the sum of all line item total amounts.",
"field": "TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.",
"displayName": "Accounts Receivable Credit Note",
"properties": {
"allocatedOnDate": {
"description": "The date the credit note was allocated",
"displayName": "Allocated On Date",
"required": false,
"type": "DateTime"
},
"creditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided if Sage Intacct is not configured to auto-generate an Adjustment Number, otherwise cannot be used.",
"field": "CreditNoteNumber"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"customerRef": {
"description": "Reference to the customer the credit note has been issued to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be used to provide Customer Id.",
"field": "CustomerRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be used to provide the date the Credit Note was created.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line item",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be an existing GL Account in Sage Intacct and not linked to any bank account.",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be an existing tax rate in Sage Intacct.",
"field": "TaxRateRef.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "It is only required for VAT enabled transactions.",
"field": "LineItems.TaxRateRef"
}
],
"warnings": []
}
},
"trackingCategoryRefs": {
"description": "A collection of categories ths item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": false,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided and must be zero or greater.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must contain at least one line item.",
"field": "LineItems"
}
],
"warnings": []
}
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be either Draft or Submitted.",
"field": "Status"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.",
"displayName": "Accounts Receivable Credit Note",
"properties": {
"additionalTaxAmount": {
"description": "Tax added to the total tax of the lines",
"displayName": "Additional Tax Amount",
"required": true,
"type": "Number"
},
"additionalTaxPercentage": {
"description": "The percentage of the additional tax to the TotalAmount",
"displayName": "Additional Tax Percentage",
"required": true,
"type": "Number"
},
"allocatedOnDate": {
"description": "The date the credit note was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"creditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": true,
"type": "String"
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"customerRef": {
"description": "Reference to the customer the credit note has been issued to",
"displayName": "Customer Reference",
"properties": {
"companyName": {
"description": "The name of the customer referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line item",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": true,
"type": "String"
},
"discountAmount": {
"description": "The value, in the given credit note currency, of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"isDirectIncome": {
"description": "True if this invoice is also mapped as a direct income",
"displayName": "Is Direct Income",
"required": true,
"type": "Boolean"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the item referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"tracking": {
"description": "A collection of items this line item is being tracked against",
"displayName": "Accounts Receivable Tracking",
"properties": {
"categoryRefs": {
"description": "A collection of categories this line item is being tracked against",
"displayName": "Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"customerRef": {
"description": "Reference to the customer this line item is being tracked against",
"displayName": "Customer Reference",
"properties": {
"companyName": {
"description": "The name of the customer referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"isBilledTo": {
"description": "The type of item this line item is billed to.",
"displayName": "Is Billed To",
"required": true,
"type": "String"
},
"isRebilledTo": {
"description": "The type of item this line item is billed to",
"displayName": "Is Rebilled To",
"required": true,
"type": "String"
},
"projectRef": {
"description": "Reference to the project this line item is being tracked against",
"displayName": "Project Reference",
"properties": {
"id": {
"description": "The reference identifier for the Project",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the Project referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories ths item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"note": {
"description": "Note about the credit note",
"displayName": "Note",
"required": true,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments that are allocated to (i.e. spend) the credit note",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the transaction",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the allocated payment",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"note": {
"description": "Any additional text based information associated with the allocated payment",
"displayName": "Note",
"required": true,
"type": "String"
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime"
},
"reference": {
"description": "Reference associated with the allocated payment",
"displayName": "Reference",
"required": true,
"type": "String"
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array"
},
"remainingCredit": {
"description": "Unused balance of total amount originally raised",
"displayName": "Remaining Credit",
"required": true,
"type": "Number"
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"required": true,
"type": "String"
},
"subTotal": {
"description": "The amount of the credit note, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"totalDiscount": {
"description": "The value, in the given credit note currency, of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"totalTaxAmount": {
"description": "The amount of tax for the credit note",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"withholdingTax": {
"description": "A collection of tax deductions",
"displayName": "Withholding Tax",
"properties": {
"amount": {
"description": "Deduction amount",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"name": {
"description": "Name of the deduction",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.",
"displayName": "Accounts Receivable Credit Note",
"properties": {
"creditNoteNumber": {
"description": "User friendly reference for the credit note",
"displayName": "Credit Note Number",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 225 characters long.",
"field": "CreditNoteNumber"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the credit note",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the credit note and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"customerRef": {
"description": "Reference to the customer the credit note has been issued to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "CustomerRef.Id"
},
{
"details": "Must match the ID of an existing customer.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The date the credit note was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the credit note",
"displayName": "Line item",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.AccountRef"
}
],
"warnings": []
}
},
"description": {
"description": "Friendly name of the goods or services credited",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided when itemRef is not provided, or when the item has no sales description in Xero.",
"field": "LineItems.Description"
}
],
"warnings": []
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "ItemRef.Id"
},
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services credited",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "It will not be mapped directly into Xero as Xero computes it automatically on its end.",
"field": "LineItems.TaxAmount"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tax rate.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "It will not be mapped directly into Xero as Xero computes it automatically on its end.",
"field": "LineItems.TotalAmount"
}
]
}
},
"trackingCategoryRefs": {
"description": "A collection of categories ths item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TrackingCategoryRefs.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Tracking categories must not have the same parent tracking category.",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "Maximum of 2 Tracking Categories.",
"field": "LineItems.TrackingCategoryRefs"
}
],
"warnings": []
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"status": {
"description": "The current state of a credit note",
"displayName": "Credit Note Status",
"options": [
{
"displayName": "Draft",
"required": false,
"type": "String",
"value": "Draft"
},
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Status"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount of the credit note, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided and must equal the sum of the link items amount.",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Must be greater than zero.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}
GET
Get credit note
{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/creditNotes/:creditNoteId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/creditNotes/:creditNoteId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/creditNotes/:creditNoteId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/creditNotes/:creditNoteId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteIdhttp GET {{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/creditNotes/:creditNoteId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List credit notes
{{baseUrl}}/companies/:companyId/data/creditNotes
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/creditNotes?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/creditNotes" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/creditNotes?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/creditNotes?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/creditNotes?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/creditNotes?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/creditNotes?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/creditNotes?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/creditNotes?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/creditNotes?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/creditNotes?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/creditNotes?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/creditNotes',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/creditNotes?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/creditNotes?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/creditNotes?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/creditNotes?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/creditNotes',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/creditNotes');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/creditNotes',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/creditNotes?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/creditNotes?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/creditNotes?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/creditNotes?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/creditNotes?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/creditNotes');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/creditNotes');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/creditNotes?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/creditNotes?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/creditNotes?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/creditNotes"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/creditNotes"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/creditNotes?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/creditNotes') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/creditNotes";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/creditNotes?page='http GET '{{baseUrl}}/companies/:companyId/data/creditNotes?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/creditNotes?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/creditNotes?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Update creditNote
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId"
payload = {}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId"
payload <- "{}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http PUT {{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteIdimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/creditNotes/:creditNoteId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create customer
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/customers HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/customers',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/customers", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/customers') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/customersimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Download customer attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/downloadhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/downloadwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/downloadimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId/download")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create-update customer model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/customers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/customers',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/customers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/customers') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/customershttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/customerswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/customersimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/customers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a 2-letter country code",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Only the first address provided will be considered, all other entries will be not be recorded",
"field": "Addresses"
}
],
"warnings": []
}
},
"contacts": {
"description": "A collection of alternative contacts for the customer",
"displayName": "Contacts",
"properties": {
"email": {
"description": "The email address for the contact",
"displayName": "Email",
"required": false,
"type": "String"
},
"name": {
"description": "The name of the contact",
"displayName": "Name",
"required": true,
"type": "String"
},
"phone": {
"description": "A collection of phone numbers for the contact",
"displayName": "Phone",
"properties": {
"number": {
"description": "The full number including country, and area code where applicable",
"displayName": "Number",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String"
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the customer",
"displayName": "Default Currency",
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String"
},
"registrationNumber": {
"description": "The customer's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only for Exact Netherlands, if provided, must be exactly 20 characters in length",
"field": "RegistrationNumber"
}
]
}
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a 2-letter country code",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Only the first address provided will be considered, all other entries will be not be recorded",
"field": "Addresses"
}
],
"warnings": []
}
},
"contacts": {
"description": "A collection of alternative contacts for the customer",
"displayName": "Contacts",
"properties": {
"email": {
"description": "The email address for the contact",
"displayName": "Email",
"required": false,
"type": "String"
},
"name": {
"description": "The name of the contact",
"displayName": "Name",
"required": true,
"type": "String"
},
"phone": {
"description": "A collection of phone numbers for the contact",
"displayName": "Phone",
"properties": {
"number": {
"description": "The full number including country, and area code where applicable",
"displayName": "Number",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String"
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the customer",
"displayName": "Default Currency",
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String"
},
"registrationNumber": {
"description": "The customer's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only for Exact Netherlands, if provided, must be exactly 20 characters in length",
"field": "RegistrationNumber"
}
]
}
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String"
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": true,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Only one address may be specified",
"field": "Addresses"
}
],
"warnings": []
}
},
"contactName": {
"description": "The name of the main contact for the customer",
"displayName": "Contact Name",
"required": true,
"type": "String"
},
"contacts": {
"description": "A collection of alternative contacts for the customer",
"displayName": "Contacts",
"properties": {
"email": {
"description": "The email address for the contact",
"displayName": "Email",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the contact",
"displayName": "Name",
"options": [
{
"displayName": "Billing Email",
"required": false,
"type": "String",
"value": "Billing Email"
}
],
"required": true,
"type": "String"
},
"phone": {
"description": "A collection of phone numbers for the contact",
"displayName": "Phone",
"properties": {
"number": {
"description": "The full number including country, and area code where applicable",
"displayName": "Number",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Billing Email should be specified in a different contact entry with the specific corresponding name.",
"field": "Contacts"
}
],
"warnings": []
}
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String"
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the customer",
"displayName": "Customer Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String"
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "No more than two addresses can be added",
"field": "Addresses"
}
]
}
},
"contactName": {
"description": "The name of the main contact for the customer",
"displayName": "Contact Name",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "The part of the name preceding the first space will be assigned to first name, the remainder to last name",
"field": "ContactName"
}
],
"warnings": []
}
},
"contacts": {
"description": "A collection of alternative contacts for the customer",
"displayName": "Contacts",
"properties": {
"email": {
"description": "The email address for the contact",
"displayName": "Email",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the contact",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "The part of the name preceding the first space will be assigned to first name, the remainder to last name",
"field": "Contacts.Name"
}
],
"warnings": []
}
},
"phone": {
"description": "A collection of phone numbers for the contact",
"displayName": "Phone",
"properties": {
"number": {
"description": "The full number including country, and area code where applicable",
"displayName": "Number",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "No more than two phone numbers per contact can be added",
"field": "Contacts.Phone"
}
]
}
}
},
"required": false,
"type": "Array"
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": false,
"type": "String"
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the customer",
"displayName": "Default Currency",
"options": [
{
"displayName": "AED",
"required": false,
"type": "Array",
"value": "AED"
},
{
"displayName": "AFN",
"required": false,
"type": "Array",
"value": "AFN"
},
{
"displayName": "ALL",
"required": false,
"type": "Array",
"value": "ALL"
},
{
"displayName": "AMD",
"required": false,
"type": "Array",
"value": "AMD"
},
{
"displayName": "ANG",
"required": false,
"type": "Array",
"value": "ANG"
},
{
"displayName": "AOA",
"required": false,
"type": "Array",
"value": "AOA"
},
{
"displayName": "ARS",
"required": false,
"type": "Array",
"value": "ARS"
},
{
"displayName": "AUD",
"required": false,
"type": "Array",
"value": "AUD"
},
{
"displayName": "AWG",
"required": false,
"type": "Array",
"value": "AWG"
},
{
"displayName": "AZN",
"required": false,
"type": "Array",
"value": "AZN"
},
{
"displayName": "BAM",
"required": false,
"type": "Array",
"value": "BAM"
},
{
"displayName": "BBD",
"required": false,
"type": "Array",
"value": "BBD"
},
{
"displayName": "BDT",
"required": false,
"type": "Array",
"value": "BDT"
},
{
"displayName": "BGN",
"required": false,
"type": "Array",
"value": "BGN"
},
{
"displayName": "BHD",
"required": false,
"type": "Array",
"value": "BHD"
},
{
"displayName": "BIF",
"required": false,
"type": "Array",
"value": "BIF"
},
{
"displayName": "BMD",
"required": false,
"type": "Array",
"value": "BMD"
},
{
"displayName": "BND",
"required": false,
"type": "Array",
"value": "BND"
},
{
"displayName": "BOB",
"required": false,
"type": "Array",
"value": "BOB"
},
{
"displayName": "BRL",
"required": false,
"type": "Array",
"value": "BRL"
},
{
"displayName": "BSD",
"required": false,
"type": "Array",
"value": "BSD"
},
{
"displayName": "BTN",
"required": false,
"type": "Array",
"value": "BTN"
},
{
"displayName": "BWP",
"required": false,
"type": "Array",
"value": "BWP"
},
{
"displayName": "BYR",
"required": false,
"type": "Array",
"value": "BYR"
},
{
"displayName": "BZD",
"required": false,
"type": "Array",
"value": "BZD"
},
{
"displayName": "CAD",
"required": false,
"type": "Array",
"value": "CAD"
},
{
"displayName": "CDF",
"required": false,
"type": "Array",
"value": "CDF"
},
{
"displayName": "CHF",
"required": false,
"type": "Array",
"value": "CHF"
},
{
"displayName": "CLP",
"required": false,
"type": "Array",
"value": "CLP"
},
{
"displayName": "CNY",
"required": false,
"type": "Array",
"value": "CNY"
},
{
"displayName": "COP",
"required": false,
"type": "Array",
"value": "COP"
},
{
"displayName": "CRC",
"required": false,
"type": "Array",
"value": "CRC"
},
{
"displayName": "CUC",
"required": false,
"type": "Array",
"value": "CUC"
},
{
"displayName": "CUP",
"required": false,
"type": "Array",
"value": "CUP"
},
{
"displayName": "CVE",
"required": false,
"type": "Array",
"value": "CVE"
},
{
"displayName": "CZK",
"required": false,
"type": "Array",
"value": "CZK"
},
{
"displayName": "DJF",
"required": false,
"type": "Array",
"value": "DJF"
},
{
"displayName": "DKK",
"required": false,
"type": "Array",
"value": "DKK"
},
{
"displayName": "DOP",
"required": false,
"type": "Array",
"value": "DOP"
},
{
"displayName": "DZD",
"required": false,
"type": "Array",
"value": "DZD"
},
{
"displayName": "EGP",
"required": false,
"type": "Array",
"value": "EGP"
},
{
"displayName": "ERN",
"required": false,
"type": "Array",
"value": "ERN"
},
{
"displayName": "ETB",
"required": false,
"type": "Array",
"value": "ETB"
},
{
"displayName": "EUR",
"required": false,
"type": "Array",
"value": "EUR"
},
{
"displayName": "FJD",
"required": false,
"type": "Array",
"value": "FJD"
},
{
"displayName": "FKP",
"required": false,
"type": "Array",
"value": "FKP"
},
{
"displayName": "GBP",
"required": false,
"type": "Array",
"value": "GBP"
},
{
"displayName": "GEL",
"required": false,
"type": "Array",
"value": "GEL"
},
{
"displayName": "GGP",
"required": false,
"type": "Array",
"value": "GGP"
},
{
"displayName": "GHS",
"required": false,
"type": "Array",
"value": "GHS"
},
{
"displayName": "GIP",
"required": false,
"type": "Array",
"value": "GIP"
},
{
"displayName": "GMD",
"required": false,
"type": "Array",
"value": "GMD"
},
{
"displayName": "GNF",
"required": false,
"type": "Array",
"value": "GNF"
},
{
"displayName": "GTQ",
"required": false,
"type": "Array",
"value": "GTQ"
},
{
"displayName": "GYD",
"required": false,
"type": "Array",
"value": "GYD"
},
{
"displayName": "HKD",
"required": false,
"type": "Array",
"value": "HKD"
},
{
"displayName": "HNL",
"required": false,
"type": "Array",
"value": "HNL"
},
{
"displayName": "HRK",
"required": false,
"type": "Array",
"value": "HRK"
},
{
"displayName": "HTG",
"required": false,
"type": "Array",
"value": "HTG"
},
{
"displayName": "HUF",
"required": false,
"type": "Array",
"value": "HUF"
},
{
"displayName": "IDR",
"required": false,
"type": "Array",
"value": "IDR"
},
{
"displayName": "ILS",
"required": false,
"type": "Array",
"value": "ILS"
},
{
"displayName": "IMP",
"required": false,
"type": "Array",
"value": "IMP"
},
{
"displayName": "INR",
"required": false,
"type": "Array",
"value": "INR"
},
{
"displayName": "IQD",
"required": false,
"type": "Array",
"value": "IQD"
},
{
"displayName": "IRR",
"required": false,
"type": "Array",
"value": "IRR"
},
{
"displayName": "ISK",
"required": false,
"type": "Array",
"value": "ISK"
},
{
"displayName": "JEP",
"required": false,
"type": "Array",
"value": "JEP"
},
{
"displayName": "JMD",
"required": false,
"type": "Array",
"value": "JMD"
},
{
"displayName": "JOD",
"required": false,
"type": "Array",
"value": "JOD"
},
{
"displayName": "JPY",
"required": false,
"type": "Array",
"value": "JPY"
},
{
"displayName": "KES",
"required": false,
"type": "Array",
"value": "KES"
},
{
"displayName": "KGS",
"required": false,
"type": "Array",
"value": "KGS"
},
{
"displayName": "KHR",
"required": false,
"type": "Array",
"value": "KHR"
},
{
"displayName": "KMF",
"required": false,
"type": "Array",
"value": "KMF"
},
{
"displayName": "KPW",
"required": false,
"type": "Array",
"value": "KPW"
},
{
"displayName": "KRW",
"required": false,
"type": "Array",
"value": "KRW"
},
{
"displayName": "KWD",
"required": false,
"type": "Array",
"value": "KWD"
},
{
"displayName": "KYD",
"required": false,
"type": "Array",
"value": "KYD"
},
{
"displayName": "KZT",
"required": false,
"type": "Array",
"value": "KZT"
},
{
"displayName": "LAK",
"required": false,
"type": "Array",
"value": "LAK"
},
{
"displayName": "LBP",
"required": false,
"type": "Array",
"value": "LBP"
},
{
"displayName": "LKR",
"required": false,
"type": "Array",
"value": "LKR"
},
{
"displayName": "LRD",
"required": false,
"type": "Array",
"value": "LRD"
},
{
"displayName": "LSL",
"required": false,
"type": "Array",
"value": "LSL"
},
{
"displayName": "LYD",
"required": false,
"type": "Array",
"value": "LYD"
},
{
"displayName": "MAD",
"required": false,
"type": "Array",
"value": "MAD"
},
{
"displayName": "MDL",
"required": false,
"type": "Array",
"value": "MDL"
},
{
"displayName": "MGA",
"required": false,
"type": "Array",
"value": "MGA"
},
{
"displayName": "MKD",
"required": false,
"type": "Array",
"value": "MKD"
},
{
"displayName": "MMK",
"required": false,
"type": "Array",
"value": "MMK"
},
{
"displayName": "MNT",
"required": false,
"type": "Array",
"value": "MNT"
},
{
"displayName": "MOP",
"required": false,
"type": "Array",
"value": "MOP"
},
{
"displayName": "MRO",
"required": false,
"type": "Array",
"value": "MRO"
},
{
"displayName": "MUR",
"required": false,
"type": "Array",
"value": "MUR"
},
{
"displayName": "MVR",
"required": false,
"type": "Array",
"value": "MVR"
},
{
"displayName": "MWK",
"required": false,
"type": "Array",
"value": "MWK"
},
{
"displayName": "MXN",
"required": false,
"type": "Array",
"value": "MXN"
},
{
"displayName": "MYR",
"required": false,
"type": "Array",
"value": "MYR"
},
{
"displayName": "MZN",
"required": false,
"type": "Array",
"value": "MZN"
},
{
"displayName": "NAD",
"required": false,
"type": "Array",
"value": "NAD"
},
{
"displayName": "NGN",
"required": false,
"type": "Array",
"value": "NGN"
},
{
"displayName": "NIO",
"required": false,
"type": "Array",
"value": "NIO"
},
{
"displayName": "NOK",
"required": false,
"type": "Array",
"value": "NOK"
},
{
"displayName": "NPR",
"required": false,
"type": "Array",
"value": "NPR"
},
{
"displayName": "NZD",
"required": false,
"type": "Array",
"value": "NZD"
},
{
"displayName": "OMR",
"required": false,
"type": "Array",
"value": "OMR"
},
{
"displayName": "PAB",
"required": false,
"type": "Array",
"value": "PAB"
},
{
"displayName": "PEN",
"required": false,
"type": "Array",
"value": "PEN"
},
{
"displayName": "PGK",
"required": false,
"type": "Array",
"value": "PGK"
},
{
"displayName": "PHP",
"required": false,
"type": "Array",
"value": "PHP"
},
{
"displayName": "PKR",
"required": false,
"type": "Array",
"value": "PKR"
},
{
"displayName": "PLN",
"required": false,
"type": "Array",
"value": "PLN"
},
{
"displayName": "PYG",
"required": false,
"type": "Array",
"value": "PYG"
},
{
"displayName": "QAR",
"required": false,
"type": "Array",
"value": "QAR"
},
{
"displayName": "RON",
"required": false,
"type": "Array",
"value": "RON"
},
{
"displayName": "RSD",
"required": false,
"type": "Array",
"value": "RSD"
},
{
"displayName": "RUB",
"required": false,
"type": "Array",
"value": "RUB"
},
{
"displayName": "RWF",
"required": false,
"type": "Array",
"value": "RWF"
},
{
"displayName": "SAR",
"required": false,
"type": "Array",
"value": "SAR"
},
{
"displayName": "SBD",
"required": false,
"type": "Array",
"value": "SBD"
},
{
"displayName": "SCR",
"required": false,
"type": "Array",
"value": "SCR"
},
{
"displayName": "SDG",
"required": false,
"type": "Array",
"value": "SDG"
},
{
"displayName": "SEK",
"required": false,
"type": "Array",
"value": "SEK"
},
{
"displayName": "SGD",
"required": false,
"type": "Array",
"value": "SGD"
},
{
"displayName": "SHP",
"required": false,
"type": "Array",
"value": "SHP"
},
{
"displayName": "SLL",
"required": false,
"type": "Array",
"value": "SLL"
},
{
"displayName": "SOS",
"required": false,
"type": "Array",
"value": "SOS"
},
{
"displayName": "SPL",
"required": false,
"type": "Array",
"value": "SPL"
},
{
"displayName": "SRD",
"required": false,
"type": "Array",
"value": "SRD"
},
{
"displayName": "STD",
"required": false,
"type": "Array",
"value": "STD"
},
{
"displayName": "SVC",
"required": false,
"type": "Array",
"value": "SVC"
},
{
"displayName": "SYP",
"required": false,
"type": "Array",
"value": "SYP"
},
{
"displayName": "SZL",
"required": false,
"type": "Array",
"value": "SZL"
},
{
"displayName": "THB",
"required": false,
"type": "Array",
"value": "THB"
},
{
"displayName": "TJS",
"required": false,
"type": "Array",
"value": "TJS"
},
{
"displayName": "TMT",
"required": false,
"type": "Array",
"value": "TMT"
},
{
"displayName": "TND",
"required": false,
"type": "Array",
"value": "TND"
},
{
"displayName": "TOP",
"required": false,
"type": "Array",
"value": "TOP"
},
{
"displayName": "TRY",
"required": false,
"type": "Array",
"value": "TRY"
},
{
"displayName": "TTD",
"required": false,
"type": "Array",
"value": "TTD"
},
{
"displayName": "TVD",
"required": false,
"type": "Array",
"value": "TVD"
},
{
"displayName": "TWD",
"required": false,
"type": "Array",
"value": "TWD"
},
{
"displayName": "TZS",
"required": false,
"type": "Array",
"value": "TZS"
},
{
"displayName": "UAH",
"required": false,
"type": "Array",
"value": "UAH"
},
{
"displayName": "UGX",
"required": false,
"type": "Array",
"value": "UGX"
},
{
"displayName": "USD",
"required": false,
"type": "Array",
"value": "USD"
},
{
"displayName": "UYU",
"required": false,
"type": "Array",
"value": "UYU"
},
{
"displayName": "UZS",
"required": false,
"type": "Array",
"value": "UZS"
},
{
"displayName": "VEF",
"required": false,
"type": "Array",
"value": "VEF"
},
{
"displayName": "VND",
"required": false,
"type": "Array",
"value": "VND"
},
{
"displayName": "VUV",
"required": false,
"type": "Array",
"value": "VUV"
},
{
"displayName": "WST",
"required": false,
"type": "Array",
"value": "WST"
},
{
"displayName": "XAF",
"required": false,
"type": "Array",
"value": "XAF"
},
{
"displayName": "XCD",
"required": false,
"type": "Array",
"value": "XCD"
},
{
"displayName": "XDR",
"required": false,
"type": "Array",
"value": "XDR"
},
{
"displayName": "XOF",
"required": false,
"type": "Array",
"value": "XOF"
},
{
"displayName": "XPF",
"required": false,
"type": "Array",
"value": "XPF"
},
{
"displayName": "YER",
"required": false,
"type": "Array",
"value": "YER"
},
{
"displayName": "ZAR",
"required": false,
"type": "Array",
"value": "ZAR"
},
{
"displayName": "ZMW",
"required": false,
"type": "Array",
"value": "ZMW"
},
{
"displayName": "ZWD",
"required": false,
"type": "Array",
"value": "ZWD"
}
],
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid email.",
"field": "EmailAddress"
}
]
}
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String"
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "Addresses.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "Addresses.Line1"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 11 characters",
"field": "Addresses.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "Addresses.Region"
}
]
}
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Billing",
"required": false,
"type": "String",
"value": "Billing"
},
{
"displayName": "Delivery",
"required": false,
"type": "String",
"value": "Delivery"
}
],
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"contactName": {
"description": "The name of the main contact for the customer",
"displayName": "Contact Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 25 characters",
"field": "ContactName"
}
]
}
},
"contacts": {
"description": "A collection of alternative contacts for the customer",
"displayName": "Contacts",
"properties": {
"address": {
"description": "The address for the contact",
"displayName": "Address",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "Address.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "Address.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "Address.Line1"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 11 characters",
"field": "Address.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "Address.Region"
}
]
}
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Billing",
"required": false,
"type": "String",
"value": "Billing"
},
{
"displayName": "Delivery",
"required": false,
"type": "String",
"value": "Delivery"
},
{
"displayName": "Unknown",
"required": false,
"type": "String",
"value": "Unknown"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"email": {
"description": "The email address for the contact",
"displayName": "Email",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "Contacts.Email"
}
]
}
},
"name": {
"description": "The name of the contact",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 25 characters",
"field": "Contacts.Name"
}
]
}
},
"phone": {
"description": "A collection of phone numbers for the contact",
"displayName": "Phone",
"properties": {
"number": {
"description": "The full number including country, and area code where applicable",
"displayName": "Number",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 21 characters",
"field": "Phone.Number"
}
]
}
},
"type": {
"description": "The type of phone number",
"displayName": "Phone Type",
"options": [
{
"displayName": "Unknown",
"required": false,
"type": "String",
"value": "Unknown"
},
{
"displayName": "Fax",
"required": false,
"type": "String",
"value": "Fax"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Do not set or set to Unknown for phone numbers; set to Fax for fax number",
"field": "Phone.Type"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must contain a maximum of 3 phone numbers",
"field": "Contacts.Phone"
},
{
"details": "Must contain a maximum of 1 fax number",
"field": "Contacts.Phone"
}
]
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have at most five contacts",
"field": "Contacts"
},
{
"details": "Must have at least one piece of contact information",
"field": "Contacts"
}
]
}
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 50 characters",
"field": "CustomerName"
}
]
}
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 255 characters",
"field": "EmailAddress"
}
]
}
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 21 characters",
"field": "Phone"
}
]
}
},
"registrationNumber": {
"description": "The customer's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid ABN (Australian Business Number) in the format XX XXX XXX XXX",
"field": "RegistrationNumber"
},
{
"details": "Must have a length of 14 characters",
"field": "RegistrationNumber"
}
]
}
},
"status": {
"description": "The current state of the customer",
"displayName": "Customer Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have a length between 1 and 19 characters",
"field": "TaxNumber"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a two letter Country ISO code",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Billing",
"required": false,
"type": "String",
"value": "Billing"
},
{
"displayName": "Delivery",
"required": false,
"type": "String",
"value": "Delivery"
},
{
"displayName": "Unknown",
"required": false,
"type": "String",
"value": "Unknown"
}
],
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Multiple addresses of Unknown type may be provided",
"field": "Addresses"
}
],
"warnings": [
{
"details": "Only one each of Billing and Delivery addresses can be provided",
"field": "Addresses"
}
]
}
},
"contacts": {
"description": "A collection of alternative contacts for the customer",
"displayName": "Contacts",
"properties": {
"email": {
"description": "The email address for the contact",
"displayName": "Email",
"required": false,
"type": "String"
},
"name": {
"description": "The name of the contact",
"displayName": "Name",
"required": true,
"type": "String"
},
"phone": {
"description": "A collection of phone numbers for the contact",
"displayName": "Phone",
"properties": {
"number": {
"description": "The full number including country, and area code where applicable",
"displayName": "Number",
"required": true,
"type": "String"
},
"type": {
"description": "The type of phone number",
"displayName": "Phone Type",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a maximum of four distinct number types",
"field": "Contacts.Phone"
}
]
}
},
"status": {
"description": "The current state of the contact",
"displayName": "Contact Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String"
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the customer",
"displayName": "Default Currency",
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the customer",
"displayName": "Customer Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 31 characters.",
"field": "Addresses.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 31 characters.",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 41 characters.",
"field": "Addresses.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 41 characters.",
"field": "Addresses.Line2"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 13 characters.",
"field": "Addresses.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 21 characters.",
"field": "Addresses.Region"
}
]
}
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Billing Address",
"required": false,
"type": "String",
"value": "Billing"
},
{
"displayName": "Delivery Address",
"required": false,
"type": "String",
"value": "Delivery"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Only 1 address each of type(s) Billing/Delivery may be specified.",
"field": "Addresses.Type"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array"
},
"contactName": {
"description": "The name of the main contact for the customer",
"displayName": "Contact Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 25 characters for first and last names",
"field": "ContactName"
}
]
}
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 41 characters.",
"field": "CustomerName"
}
]
}
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the customer",
"displayName": "Default Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the base currency of the QuickBooks Desktop company",
"field": "DefaultCurrency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company",
"field": "DefaultCurrency"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "DefaultCurrency"
}
]
}
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 21 characters",
"field": "Phone"
}
]
}
},
"registrationNumber": {
"description": "The customer's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 15 characters.",
"field": "RegistrationNumber"
}
]
}
},
"status": {
"description": "The current state of the customer",
"displayName": "Customer Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 30 characters.",
"field": "TaxNumber"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 255 characters.",
"field": "Addresses.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 50 characters.",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "Addresses.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "Addresses.Line2"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only English alphabet characters are permitted.",
"field": "Addresses.PostalCode"
},
{
"details": "Max length of 50 characters.",
"field": "Addresses.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 225 characters.",
"field": "Addresses.Region"
}
]
}
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Billing Address",
"required": false,
"type": "String",
"value": "Billing"
},
{
"displayName": "Delivery Address",
"required": false,
"type": "String",
"value": "Delivery"
}
],
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Billing = POBOX, Delivery/Unknown = DELIVERY",
"field": "Addresses.Type"
}
]
}
}
},
"required": false,
"type": "Array"
},
"contacts": {
"description": "A collection of alternative contacts for the customer",
"displayName": "Contacts",
"properties": {
"phone": {
"description": "A collection of phone numbers for the contact",
"displayName": "Phone",
"properties": {
"number": {
"description": "The full number including country, and area code where applicable",
"displayName": "Number",
"required": true,
"type": "String"
},
"type": {
"description": "The type of phone number",
"displayName": "Phone Type",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
}
},
"required": false,
"type": "Array"
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Names must be unique across customers, suppliers and employees",
"field": "CustomerName"
}
]
}
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the customer",
"displayName": "Default Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Default currency can only differ from the base company currency if multi-currency is enabled for the company.",
"field": "DefaultCurrency"
}
]
}
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Country, area, and number are space separated",
"field": "Phone"
}
]
}
},
"registrationNumber": {
"description": "The customer's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the customer",
"displayName": "Customer Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 255 characters.",
"field": "Addresses.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 50 characters.",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "Addresses.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "Addresses.Line2"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only English alphabet characters are permitted.",
"field": "Addresses.PostalCode"
},
{
"details": "Max length of 50 characters.",
"field": "Addresses.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 225 characters.",
"field": "Addresses.Region"
}
]
}
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Billing Address",
"required": false,
"type": "String",
"value": "Billing"
},
{
"displayName": "Delivery Address",
"required": false,
"type": "String",
"value": "Delivery"
}
],
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Billing = POBOX, Delivery/Unknown = DELIVERY",
"field": "Addresses.Type"
}
]
}
}
},
"required": false,
"type": "Array"
},
"contacts": {
"description": "A collection of alternative contacts for the customer",
"displayName": "Contacts",
"properties": {
"phone": {
"description": "A collection of phone numbers for the contact",
"displayName": "Phone",
"properties": {
"number": {
"description": "The full number including country, and area code where applicable",
"displayName": "Number",
"required": true,
"type": "String"
},
"type": {
"description": "The type of phone number",
"displayName": "Phone Type",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
}
},
"required": false,
"type": "Array"
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Names must be unique across customers, suppliers and employees",
"field": "CustomerName"
}
]
}
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the customer",
"displayName": "Default Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Default currency can only differ from the base company currency if multi-currency is enabled for the company.",
"field": "DefaultCurrency"
}
]
}
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Country, area, and number are space separated",
"field": "Phone"
}
]
}
},
"registrationNumber": {
"description": "The customer's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the customer",
"displayName": "Customer Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "Contact addresses for the customer.",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The city of the customer address.",
"displayName": "City",
"required": false,
"type": "String"
},
"countryCode": {
"description": "The country code of the customer address",
"displayName": "Country Code",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "XX is a valid country code for 'Unknown Country'"
}
],
"warnings": [
{
"details": "The country code must be a valid ISO 3166 value"
}
]
}
},
"line1": {
"description": "Line 1 of the customer address.",
"displayName": "Line 1",
"required": true,
"type": "String"
},
"line2": {
"description": "Line 2 of the customer address.",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "Post or Zip code for the address.",
"displayName": "Postal code",
"required": false,
"type": "String"
},
"region": {
"description": "The region of the customer address.",
"displayName": "Region",
"required": false,
"type": "String"
},
"type": {
"description": "The type of address as it related to the customer.",
"displayName": "Type",
"options": [
{
"displayName": "Delivery Address",
"required": false,
"type": "String",
"value": "Delivery"
},
{
"displayName": "Unknown Address",
"required": false,
"type": "String",
"value": "Unknown"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If the address is available in 'SALES_DEL_ADDR' table then the address type will be Delivery. All others will default to type 'Unknown'",
"field": "addresses.type"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Only one address can be included in the Addresses array.",
"field": "addresses"
}
]
}
},
"contactName": {
"description": "The name of the main contact for the customer.",
"displayName": "Contact Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "The contact name can have a maximum of 30 characters",
"field": "contactName"
}
]
}
},
"customerName": {
"description": "Name of the customer.",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "The customer name can have a maximum of 60 characters",
"field": "customerName"
}
]
}
},
"defaultCurrency": {
"description": "The currency in which the customer will operate.",
"displayName": "Default Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not provided, the currency will default to the company's base currency.",
"field": "defaultCurrency"
}
],
"warnings": []
}
},
"emailAddress": {
"description": "The email address that the customer may be contacted on.",
"displayName": "Email Address",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "The email address can have a maximum of 255 characters",
"field": "emailAddress"
}
]
}
},
"id": {
"description": "ID of the customer.",
"displayName": "Id",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "The customer ID must be all Uppercase, if it is not, it will be converted to Uppercase before pushing.",
"field": "id"
}
],
"warnings": [
{
"details": "The customer ID must be unique, contain no spaces and have a maximum of 8 characters.",
"field": "id"
}
]
}
},
"phone": {
"description": "The telephone number that the customer may be contacted on.",
"displayName": "Telephone",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "The phone can have a maximum of 30 characters",
"field": "phone"
}
]
}
},
"status": {
"description": "The status of the customer.",
"displayName": "Status",
"options": [
{
"displayName": "Active Status",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived Status",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": false,
"type": "String"
},
"taxNumber": {
"description": "Legal company registration identifier.",
"displayName": "Tax Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "The tax number can have a maximum of 20 characters",
"field": "taxNumber"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"options": [
{
"displayName": "Afghanistan (AF)",
"required": false,
"type": "String",
"value": "Afghanistan (AF)"
},
{
"displayName": "Albania (AL)",
"required": false,
"type": "String",
"value": "Albania (AL)"
},
{
"displayName": "Algeria (DZ)",
"required": false,
"type": "String",
"value": "Algeria (DZ)"
},
{
"displayName": "Andorra (AD)",
"required": false,
"type": "String",
"value": "Andorra (AD)"
},
{
"displayName": "Angola (AO)",
"required": false,
"type": "String",
"value": "Angola (AO)"
},
{
"displayName": "Argentina (AR)",
"required": false,
"type": "String",
"value": "Argentina (AR)"
},
{
"displayName": "Armenia (AM)",
"required": false,
"type": "String",
"value": "Armenia (AM)"
},
{
"displayName": "Aruba (AW)",
"required": false,
"type": "String",
"value": "Aruba (AW)"
},
{
"displayName": "Australia (AU)",
"required": false,
"type": "String",
"value": "Australia (AU)"
},
{
"displayName": "Austria (AT)",
"required": false,
"type": "String",
"value": "Austria (AT)"
},
{
"displayName": "Azerbaijan (AZ)",
"required": false,
"type": "String",
"value": "Azerbaijan (AZ)"
},
{
"displayName": "Bahamas (BS)",
"required": false,
"type": "String",
"value": "Bahamas (BS)"
},
{
"displayName": "Bahrain (BH)",
"required": false,
"type": "String",
"value": "Bahrain (BH)"
},
{
"displayName": "Bangladesh (BD)",
"required": false,
"type": "String",
"value": "Bangladesh (BD)"
},
{
"displayName": "Barbados (BB)",
"required": false,
"type": "String",
"value": "Barbados (BB)"
},
{
"displayName": "Belarus (BY)",
"required": false,
"type": "String",
"value": "Belarus (BY)"
},
{
"displayName": "Belgium (BE)",
"required": false,
"type": "String",
"value": "Belgium (BE)"
},
{
"displayName": "Belize (BZ)",
"required": false,
"type": "String",
"value": "Belize (BZ)"
},
{
"displayName": "Benin (BJ)",
"required": false,
"type": "String",
"value": "Benin (BJ)"
},
{
"displayName": "Bermuda (BM)",
"required": false,
"type": "String",
"value": "Bermuda (BM)"
},
{
"displayName": "Bhutan (BT)",
"required": false,
"type": "String",
"value": "Bhutan (BT)"
},
{
"displayName": "Bolivia (BO)",
"required": false,
"type": "String",
"value": "Bolivia (BO)"
},
{
"displayName": "Bosnia and Herzegovina (BA)",
"required": false,
"type": "String",
"value": "Bosnia and Herzegovina (BA)"
},
{
"displayName": "Botswana (BW)",
"required": false,
"type": "String",
"value": "Botswana (BW)"
},
{
"displayName": "Brazil (BR)",
"required": false,
"type": "String",
"value": "Brazil (BR)"
},
{
"displayName": "British Virgin Islands (VG)",
"required": false,
"type": "String",
"value": "British Virgin Islands (VG)"
},
{
"displayName": "Brunei Darussalam (BN)",
"required": false,
"type": "String",
"value": "Brunei Darussalam (BN)"
},
{
"displayName": "Bulgaria (BG)",
"required": false,
"type": "String",
"value": "Bulgaria (BG)"
},
{
"displayName": "Burkina Faso (BF)",
"required": false,
"type": "String",
"value": "Burkina Faso (BF)"
},
{
"displayName": "Burundi (BI)",
"required": false,
"type": "String",
"value": "Burundi (BI)"
},
{
"displayName": "Cambodia (KH)",
"required": false,
"type": "String",
"value": "Cambodia (KH)"
},
{
"displayName": "Cameroon (CM)",
"required": false,
"type": "String",
"value": "Cameroon (CM)"
},
{
"displayName": "Canada (CA)",
"required": false,
"type": "String",
"value": "Canada (CA)"
},
{
"displayName": "Cape Verde (CV)",
"required": false,
"type": "String",
"value": "Cape Verde (CV)"
},
{
"displayName": "Cayman Islands (KY)",
"required": false,
"type": "String",
"value": "Cayman Islands (KY)"
},
{
"displayName": "Central African Republic (CF)",
"required": false,
"type": "String",
"value": "Central African Republic (CF)"
},
{
"displayName": "Chad (TD)",
"required": false,
"type": "String",
"value": "Chad (TD)"
},
{
"displayName": "Chile (CL)",
"required": false,
"type": "String",
"value": "Chile (CL)"
},
{
"displayName": "China (CN)",
"required": false,
"type": "String",
"value": "China (CN)"
},
{
"displayName": "Colombia (CO)",
"required": false,
"type": "String",
"value": "Colombia (CO)"
},
{
"displayName": "Comoros (KM)",
"required": false,
"type": "String",
"value": "Comoros (KM)"
},
{
"displayName": "Congo (CG)",
"required": false,
"type": "String",
"value": "Congo (CG)"
},
{
"displayName": "Costa Rica (CR)",
"required": false,
"type": "String",
"value": "Costa Rica (CR)"
},
{
"displayName": "Croatia (HR)",
"required": false,
"type": "String",
"value": "Croatia (HR)"
},
{
"displayName": "Cuba (CU)",
"required": false,
"type": "String",
"value": "Cuba (CU)"
},
{
"displayName": "Cura�ao (CW)",
"required": false,
"type": "String",
"value": "Cura�ao (CW)"
},
{
"displayName": "Cyprus (CY)",
"required": false,
"type": "String",
"value": "Cyprus (CY)"
},
{
"displayName": "Czech Republic (CZ)",
"required": false,
"type": "String",
"value": "Czech Republic (CZ)"
},
{
"displayName": "Democratic Republic of the Congo (CD)",
"required": false,
"type": "String",
"value": "Democratic Republic of the Congo (CD)"
},
{
"displayName": "Denmark (DK)",
"required": false,
"type": "String",
"value": "Denmark (DK)"
},
{
"displayName": "Djibouti (DJ)",
"required": false,
"type": "String",
"value": "Djibouti (DJ)"
},
{
"displayName": "Dominica (DM)",
"required": false,
"type": "String",
"value": "Dominica (DM)"
},
{
"displayName": "Dominican Republic (DO)",
"required": false,
"type": "String",
"value": "Dominican Republic (DO)"
},
{
"displayName": "East Timor (TP)",
"required": false,
"type": "String",
"value": "East Timor (TP)"
},
{
"displayName": "Ecuador (EC)",
"required": false,
"type": "String",
"value": "Ecuador (EC)"
},
{
"displayName": "Egypt (EG)",
"required": false,
"type": "String",
"value": "Egypt (EG)"
},
{
"displayName": "El Salvador (SV)",
"required": false,
"type": "String",
"value": "El Salvador (SV)"
},
{
"displayName": "Equatorial Guinea (GQ)",
"required": false,
"type": "String",
"value": "Equatorial Guinea (GQ)"
},
{
"displayName": "Eritrea (ER)",
"required": false,
"type": "String",
"value": "Eritrea (ER)"
},
{
"displayName": "Estonia (EE)",
"required": false,
"type": "String",
"value": "Estonia (EE)"
},
{
"displayName": "Ethiopia (ET)",
"required": false,
"type": "String",
"value": "Ethiopia (ET)"
},
{
"displayName": "Falkland Islands (Malvinas) (FK)",
"required": false,
"type": "String",
"value": "Falkland Islands (Malvinas) (FK)"
},
{
"displayName": "Federated States of Micronesia (FM)",
"required": false,
"type": "String",
"value": "Federated States of Micronesia (FM)"
},
{
"displayName": "Fiji (FJ)",
"required": false,
"type": "String",
"value": "Fiji (FJ)"
},
{
"displayName": "Finland (FI)",
"required": false,
"type": "String",
"value": "Finland (FI)"
},
{
"displayName": "France (FR)",
"required": false,
"type": "String",
"value": "France (FR)"
},
{
"displayName": "French Polynesia (PF)",
"required": false,
"type": "String",
"value": "French Polynesia (PF)"
},
{
"displayName": "Gabon (GA)",
"required": false,
"type": "String",
"value": "Gabon (GA)"
},
{
"displayName": "Gambia (GM)",
"required": false,
"type": "String",
"value": "Gambia (GM)"
},
{
"displayName": "Georgia (GE)",
"required": false,
"type": "String",
"value": "Georgia (GE)"
},
{
"displayName": "Germany (DE)",
"required": false,
"type": "String",
"value": "Germany (DE)"
},
{
"displayName": "Ghana (GH)",
"required": false,
"type": "String",
"value": "Ghana (GH)"
},
{
"displayName": "Gibraltar (GI)",
"required": false,
"type": "String",
"value": "Gibraltar (GI)"
},
{
"displayName": "Greece (GR)",
"required": false,
"type": "String",
"value": "Greece (GR)"
},
{
"displayName": "Greenland (GL)",
"required": false,
"type": "String",
"value": "Greenland (GL)"
},
{
"displayName": "Grenada (GD)",
"required": false,
"type": "String",
"value": "Grenada (GD)"
},
{
"displayName": "Guadaloupe (GP)",
"required": false,
"type": "String",
"value": "Guadaloupe (GP)"
},
{
"displayName": "Guam (GU)",
"required": false,
"type": "String",
"value": "Guam (GU)"
},
{
"displayName": "Guatemala (GT)",
"required": false,
"type": "String",
"value": "Guatemala (GT)"
},
{
"displayName": "Guernsey (GG)",
"required": false,
"type": "String",
"value": "Guernsey (GG)"
},
{
"displayName": "Guinea (GN)",
"required": false,
"type": "String",
"value": "Guinea (GN)"
},
{
"displayName": "Guinea-Bissau (GW)",
"required": false,
"type": "String",
"value": "Guinea-Bissau (GW)"
},
{
"displayName": "Guyana (GY)",
"required": false,
"type": "String",
"value": "Guyana (GY)"
},
{
"displayName": "Haiti (HT)",
"required": false,
"type": "String",
"value": "Haiti (HT)"
},
{
"displayName": "Honduras (HN)",
"required": false,
"type": "String",
"value": "Honduras (HN)"
},
{
"displayName": "Hong Kong (HK)",
"required": false,
"type": "String",
"value": "Hong Kong (HK)"
},
{
"displayName": "Hungary (HU)",
"required": false,
"type": "String",
"value": "Hungary (HU)"
},
{
"displayName": "Iceland (IS)",
"required": false,
"type": "String",
"value": "Iceland (IS)"
},
{
"displayName": "India (IN)",
"required": false,
"type": "String",
"value": "India (IN)"
},
{
"displayName": "Indonesia (ID)",
"required": false,
"type": "String",
"value": "Indonesia (ID)"
},
{
"displayName": "Iran (IR)",
"required": false,
"type": "String",
"value": "Iran (IR)"
},
{
"displayName": "Iraq (IQ)",
"required": false,
"type": "String",
"value": "Iraq (IQ)"
},
{
"displayName": "Ireland (IE)",
"required": false,
"type": "String",
"value": "Ireland (IE)"
},
{
"displayName": "Israel (IL)",
"required": false,
"type": "String",
"value": "Israel (IL)"
},
{
"displayName": "Italy (IT)",
"required": false,
"type": "String",
"value": "Italy (IT)"
},
{
"displayName": "Ivory Coast (CI)",
"required": false,
"type": "String",
"value": "Ivory Coast (CI)"
},
{
"displayName": "Jamaica (JM)",
"required": false,
"type": "String",
"value": "Jamaica (JM)"
},
{
"displayName": "Japan (JP)",
"required": false,
"type": "String",
"value": "Japan (JP)"
},
{
"displayName": "Jersey (JE)",
"required": false,
"type": "String",
"value": "Jersey (JE)"
},
{
"displayName": "Jordan (JO)",
"required": false,
"type": "String",
"value": "Jordan (JO)"
},
{
"displayName": "Kazakhstan (KZ)",
"required": false,
"type": "String",
"value": "Kazakhstan (KZ)"
},
{
"displayName": "Kenya (KE)",
"required": false,
"type": "String",
"value": "Kenya (KE)"
},
{
"displayName": "Kuwait (KW)",
"required": false,
"type": "String",
"value": "Kuwait (KW)"
},
{
"displayName": "Kyrgyzstan (KG)",
"required": false,
"type": "String",
"value": "Kyrgyzstan (KG)"
},
{
"displayName": "Laos (LA)",
"required": false,
"type": "String",
"value": "Laos (LA)"
},
{
"displayName": "Latvia (LV)",
"required": false,
"type": "String",
"value": "Latvia (LV)"
},
{
"displayName": "Lebanon (LB)",
"required": false,
"type": "String",
"value": "Lebanon (LB)"
},
{
"displayName": "Lesotho (LS)",
"required": false,
"type": "String",
"value": "Lesotho (LS)"
},
{
"displayName": "Liberia (LR)",
"required": false,
"type": "String",
"value": "Liberia (LR)"
},
{
"displayName": "Libya (LY)",
"required": false,
"type": "String",
"value": "Libya (LY)"
},
{
"displayName": "Liechtenstein (LI)",
"required": false,
"type": "String",
"value": "Liechtenstein (LI)"
},
{
"displayName": "Lithuania (LT)",
"required": false,
"type": "String",
"value": "Lithuania (LT)"
},
{
"displayName": "Luxembourg (LU)",
"required": false,
"type": "String",
"value": "Luxembourg (LU)"
},
{
"displayName": "Macau (MO)",
"required": false,
"type": "String",
"value": "Macau (MO)"
},
{
"displayName": "Macedonia (MK)",
"required": false,
"type": "String",
"value": "Macedonia (MK)"
},
{
"displayName": "Madagascar (MG)",
"required": false,
"type": "String",
"value": "Madagascar (MG)"
},
{
"displayName": "Malawi (MW)",
"required": false,
"type": "String",
"value": "Malawi (MW)"
},
{
"displayName": "Malaysia (MY)",
"required": false,
"type": "String",
"value": "Malaysia (MY)"
},
{
"displayName": "Maldives (MV)",
"required": false,
"type": "String",
"value": "Maldives (MV)"
},
{
"displayName": "Mali (ML)",
"required": false,
"type": "String",
"value": "Mali (ML)"
},
{
"displayName": "Malta (MT)",
"required": false,
"type": "String",
"value": "Malta (MT)"
},
{
"displayName": "Mauritania (MR)",
"required": false,
"type": "String",
"value": "Mauritania (MR)"
},
{
"displayName": "Mauritius (MU)",
"required": false,
"type": "String",
"value": "Mauritius (MU)"
},
{
"displayName": "Mexico (MX)",
"required": false,
"type": "String",
"value": "Mexico (MX)"
},
{
"displayName": "Moldova (MD)",
"required": false,
"type": "String",
"value": "Moldova (MD)"
},
{
"displayName": "Monaco (MC)",
"required": false,
"type": "String",
"value": "Monaco (MC)"
},
{
"displayName": "Mongolia (MN)",
"required": false,
"type": "String",
"value": "Mongolia (MN)"
},
{
"displayName": "Montenegro (ME)",
"required": false,
"type": "String",
"value": "Montenegro (ME)"
},
{
"displayName": "Morocco (MA)",
"required": false,
"type": "String",
"value": "Morocco (MA)"
},
{
"displayName": "Mozambique (MZ)",
"required": false,
"type": "String",
"value": "Mozambique (MZ)"
},
{
"displayName": "Myanmar (MM)",
"required": false,
"type": "String",
"value": "Myanmar (MM)"
},
{
"displayName": "Namibia (NA)",
"required": false,
"type": "String",
"value": "Namibia (NA)"
},
{
"displayName": "Nepal (NP)",
"required": false,
"type": "String",
"value": "Nepal (NP)"
},
{
"displayName": "Netherlands (NL)",
"required": false,
"type": "String",
"value": "Netherlands (NL)"
},
{
"displayName": "Netherlands Antilles (AN)",
"required": false,
"type": "String",
"value": "Netherlands Antilles (AN)"
},
{
"displayName": "New Caledonia (NC)",
"required": false,
"type": "String",
"value": "New Caledonia (NC)"
},
{
"displayName": "New Zealand (NZ)",
"required": false,
"type": "String",
"value": "New Zealand (NZ)"
},
{
"displayName": "Nicaragua (NI)",
"required": false,
"type": "String",
"value": "Nicaragua (NI)"
},
{
"displayName": "Niger (NE)",
"required": false,
"type": "String",
"value": "Niger (NE)"
},
{
"displayName": "Nigeria (NG)",
"required": false,
"type": "String",
"value": "Nigeria (NG)"
},
{
"displayName": "North Korea (KP)",
"required": false,
"type": "String",
"value": "North Korea (KP)"
},
{
"displayName": "Norway (NO)",
"required": false,
"type": "String",
"value": "Norway (NO)"
},
{
"displayName": "Oman (OM)",
"required": false,
"type": "String",
"value": "Oman (OM)"
},
{
"displayName": "Pakistan (PK)",
"required": false,
"type": "String",
"value": "Pakistan (PK)"
},
{
"displayName": "Panama (PA)",
"required": false,
"type": "String",
"value": "Panama (PA)"
},
{
"displayName": "Papua New Guinea (PG)",
"required": false,
"type": "String",
"value": "Papua New Guinea (PG)"
},
{
"displayName": "Paraguay (PY)",
"required": false,
"type": "String",
"value": "Paraguay (PY)"
},
{
"displayName": "Peru (PE)",
"required": false,
"type": "String",
"value": "Peru (PE)"
},
{
"displayName": "Philippines (PH)",
"required": false,
"type": "String",
"value": "Philippines (PH)"
},
{
"displayName": "Poland (PL)",
"required": false,
"type": "String",
"value": "Poland (PL)"
},
{
"displayName": "Portugal (PT)",
"required": false,
"type": "String",
"value": "Portugal (PT)"
},
{
"displayName": "Puerto Rico (PR)",
"required": false,
"type": "String",
"value": "Puerto Rico (PR)"
},
{
"displayName": "Qatar (QA)",
"required": false,
"type": "String",
"value": "Qatar (QA)"
},
{
"displayName": "Romania (RO)",
"required": false,
"type": "String",
"value": "Romania (RO)"
},
{
"displayName": "Russia (RU)",
"required": false,
"type": "String",
"value": "Russia (RU)"
},
{
"displayName": "Rwanda (RW)",
"required": false,
"type": "String",
"value": "Rwanda (RW)"
},
{
"displayName": "Saint Kitts and Nevis (KN)",
"required": false,
"type": "String",
"value": "Saint Kitts and Nevis (KN)"
},
{
"displayName": "Saint Pierre and Miquelon (PM)",
"required": false,
"type": "String",
"value": "Saint Pierre and Miquelon (PM)"
},
{
"displayName": "Samoa (WS)",
"required": false,
"type": "String",
"value": "Samoa (WS)"
},
{
"displayName": "San Marino (SM)",
"required": false,
"type": "String",
"value": "San Marino (SM)"
},
{
"displayName": "Sao Tome and Principe (ST)",
"required": false,
"type": "String",
"value": "Sao Tome and Principe (ST)"
},
{
"displayName": "Saudi Arabia (SA)",
"required": false,
"type": "String",
"value": "Saudi Arabia (SA)"
},
{
"displayName": "Senegal (SN)",
"required": false,
"type": "String",
"value": "Senegal (SN)"
},
{
"displayName": "Serbia (RS)",
"required": false,
"type": "String",
"value": "Serbia (RS)"
},
{
"displayName": "Seychelles (SC)",
"required": false,
"type": "String",
"value": "Seychelles (SC)"
},
{
"displayName": "Sierra Leone (SL)",
"required": false,
"type": "String",
"value": "Sierra Leone (SL)"
},
{
"displayName": "Singapore (SG)",
"required": false,
"type": "String",
"value": "Singapore (SG)"
},
{
"displayName": "Slovakia (SK)",
"required": false,
"type": "String",
"value": "Slovakia (SK)"
},
{
"displayName": "Slovenia (SI)",
"required": false,
"type": "String",
"value": "Slovenia (SI)"
},
{
"displayName": "Solomon Islands (SB)",
"required": false,
"type": "String",
"value": "Solomon Islands (SB)"
},
{
"displayName": "Somalia (SO)",
"required": false,
"type": "String",
"value": "Somalia (SO)"
},
{
"displayName": "South Africa (ZA)",
"required": false,
"type": "String",
"value": "South Africa (ZA)"
},
{
"displayName": "South Korea (KR)",
"required": false,
"type": "String",
"value": "South Korea (KR)"
},
{
"displayName": "Spain (ES)",
"required": false,
"type": "String",
"value": "Spain (ES)"
},
{
"displayName": "Sri Lanka (LK)",
"required": false,
"type": "String",
"value": "Sri Lanka (LK)"
},
{
"displayName": "St. Lucia (LC)",
"required": false,
"type": "String",
"value": "St. Lucia (LC)"
},
{
"displayName": "Sudan (SD)",
"required": false,
"type": "String",
"value": "Sudan (SD)"
},
{
"displayName": "Surinam (SR)",
"required": false,
"type": "String",
"value": "Surinam (SR)"
},
{
"displayName": "Swaziland (SZ)",
"required": false,
"type": "String",
"value": "Swaziland (SZ)"
},
{
"displayName": "Sweden (SE)",
"required": false,
"type": "String",
"value": "Sweden (SE)"
},
{
"displayName": "Switzerland (CH)",
"required": false,
"type": "String",
"value": "Switzerland (CH)"
},
{
"displayName": "Syria (SY)",
"required": false,
"type": "String",
"value": "Syria (SY)"
},
{
"displayName": "Taiwan (TW)",
"required": false,
"type": "String",
"value": "Taiwan (TW)"
},
{
"displayName": "Tajikistan (TJ)",
"required": false,
"type": "String",
"value": "Tajikistan (TJ)"
},
{
"displayName": "Tanzania (TZ)",
"required": false,
"type": "String",
"value": "Tanzania (TZ)"
},
{
"displayName": "Thailand (TH)",
"required": false,
"type": "String",
"value": "Thailand (TH)"
},
{
"displayName": "Togo (TG)",
"required": false,
"type": "String",
"value": "Togo (TG)"
},
{
"displayName": "Tonga (TO)",
"required": false,
"type": "String",
"value": "Tonga (TO)"
},
{
"displayName": "Trinidad and Tobago (TT)",
"required": false,
"type": "String",
"value": "Trinidad and Tobago (TT)"
},
{
"displayName": "Tunisia (TN)",
"required": false,
"type": "String",
"value": "Tunisia (TN)"
},
{
"displayName": "Turkey (TR)",
"required": false,
"type": "String",
"value": "Turkey (TR)"
},
{
"displayName": "Turkmenistan (TM)",
"required": false,
"type": "String",
"value": "Turkmenistan (TM)"
},
{
"displayName": "Tuvalu (TV)",
"required": false,
"type": "String",
"value": "Tuvalu (TV)"
},
{
"displayName": "Uganda (UG)",
"required": false,
"type": "String",
"value": "Uganda (UG)"
},
{
"displayName": "Ukraine (UA)",
"required": false,
"type": "String",
"value": "Ukraine (UA)"
},
{
"displayName": "United Arab Emirates (AE)",
"required": false,
"type": "String",
"value": "United Arab Emirates (AE)"
},
{
"displayName": "United Kingdom (GB)",
"required": false,
"type": "String",
"value": "United Kingdom (GB)"
},
{
"displayName": "United States (US)",
"required": false,
"type": "String",
"value": "United States (US)"
},
{
"displayName": "Uruguay (UY)",
"required": false,
"type": "String",
"value": "Uruguay (UY)"
},
{
"displayName": "Uzbekistan (UZ)",
"required": false,
"type": "String",
"value": "Uzbekistan (UZ)"
},
{
"displayName": "Vanuatu (VU)",
"required": false,
"type": "String",
"value": "Vanuatu (VU)"
},
{
"displayName": "Venezuela (VE)",
"required": false,
"type": "String",
"value": "Venezuela (VE)"
},
{
"displayName": "Vietnam (VN)",
"required": false,
"type": "String",
"value": "Vietnam (VN)"
},
{
"displayName": "Virgin Islands U.S. (VI)",
"required": false,
"type": "String",
"value": "Virgin Islands U.S. (VI)"
},
{
"displayName": "Western Sahara (EH)",
"required": false,
"type": "String",
"value": "Western Sahara (EH)"
},
{
"displayName": "Yemen (YE)",
"required": false,
"type": "String",
"value": "Yemen (YE)"
},
{
"displayName": "Zaire (ZR)",
"required": false,
"type": "String",
"value": "Zaire (ZR)"
},
{
"displayName": "Zambia (ZM)",
"required": false,
"type": "String",
"value": "Zambia (ZM)"
},
{
"displayName": "Zimbabwe (ZW)",
"required": false,
"type": "String",
"value": "Zimbabwe (ZW)"
}
],
"required": false,
"type": "String"
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "If you're adding an address for this customer, you must also include the first line",
"field": "Addresses.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Can contain a maximum of two addresses; main address and delivery address",
"field": "Addresses"
}
],
"warnings": []
}
},
"contactName": {
"description": "The name of the main contact for the customer",
"displayName": "Contact Name",
"required": false,
"type": "String"
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String"
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the customer",
"displayName": "Default Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If Customer.DefaultCurrency is not provided; will be mapped from company base currency",
"field": "DefaultCurrency"
}
],
"warnings": []
}
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String"
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 80 characters",
"field": "Addresses.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"options": [
{
"displayName": "United States",
"required": false,
"type": "String",
"value": "United States"
},
{
"displayName": "Afghanistan",
"required": false,
"type": "String",
"value": "Afghanistan"
},
{
"displayName": "Aland Islands",
"required": false,
"type": "String",
"value": "Aland Islands"
},
{
"displayName": "Albania",
"required": false,
"type": "String",
"value": "Albania"
},
{
"displayName": "Algeria",
"required": false,
"type": "String",
"value": "Algeria"
},
{
"displayName": "American Samoa",
"required": false,
"type": "String",
"value": "American Samoa"
},
{
"displayName": "Andorra",
"required": false,
"type": "String",
"value": "Andorra"
},
{
"displayName": "Angola",
"required": false,
"type": "String",
"value": "Angola"
},
{
"displayName": "Anguilla",
"required": false,
"type": "String",
"value": "Anguilla"
},
{
"displayName": "Antarctica",
"required": false,
"type": "String",
"value": "Antarctica"
},
{
"displayName": "Antigua and Barbuda",
"required": false,
"type": "String",
"value": "Antigua and Barbuda"
},
{
"displayName": "Argentina",
"required": false,
"type": "String",
"value": "Argentina"
},
{
"displayName": "Armenia",
"required": false,
"type": "String",
"value": "Armenia"
},
{
"displayName": "Aruba",
"required": false,
"type": "String",
"value": "Aruba"
},
{
"displayName": "Australia",
"required": false,
"type": "String",
"value": "Australia"
},
{
"displayName": "Austria",
"required": false,
"type": "String",
"value": "Austria"
},
{
"displayName": "Azerbaijan",
"required": false,
"type": "String",
"value": "Azerbaijan"
},
{
"displayName": "Bahamas",
"required": false,
"type": "String",
"value": "Bahamas"
},
{
"displayName": "Bahrain",
"required": false,
"type": "String",
"value": "Bahrain"
},
{
"displayName": "Bangladesh",
"required": false,
"type": "String",
"value": "Bangladesh"
},
{
"displayName": "Barbados",
"required": false,
"type": "String",
"value": "Barbados"
},
{
"displayName": "Belarus",
"required": false,
"type": "String",
"value": "Belarus"
},
{
"displayName": "Belgium",
"required": false,
"type": "String",
"value": "Belgium"
},
{
"displayName": "Belize",
"required": false,
"type": "String",
"value": "Belize"
},
{
"displayName": "Benin",
"required": false,
"type": "String",
"value": "Benin"
},
{
"displayName": "Bermuda",
"required": false,
"type": "String",
"value": "Bermuda"
},
{
"displayName": "Bhutan",
"required": false,
"type": "String",
"value": "Bhutan"
},
{
"displayName": "Bolivia",
"required": false,
"type": "String",
"value": "Bolivia"
},
{
"displayName": "Bonaire, Sint Eustatius and Saba",
"required": false,
"type": "String",
"value": "Bonaire, Sint Eustatius and Saba"
},
{
"displayName": "Bosnia and Herzegovina",
"required": false,
"type": "String",
"value": "Bosnia and Herzegovina"
},
{
"displayName": "Botswana",
"required": false,
"type": "String",
"value": "Botswana"
},
{
"displayName": "Bouvet Island",
"required": false,
"type": "String",
"value": "Bouvet Island"
},
{
"displayName": "Brazil",
"required": false,
"type": "String",
"value": "Brazil"
},
{
"displayName": "British Indian Ocean Territory",
"required": false,
"type": "String",
"value": "British Indian Ocean Territory"
},
{
"displayName": "Brunei Darussalam",
"required": false,
"type": "String",
"value": "Brunei Darussalam"
},
{
"displayName": "Bulgaria",
"required": false,
"type": "String",
"value": "Bulgaria"
},
{
"displayName": "Burkina Faso",
"required": false,
"type": "String",
"value": "Burkina Faso"
},
{
"displayName": "Burundi",
"required": false,
"type": "String",
"value": "Burundi"
},
{
"displayName": "Cambodia",
"required": false,
"type": "String",
"value": "Cambodia"
},
{
"displayName": "Cameroon",
"required": false,
"type": "String",
"value": "Cameroon"
},
{
"displayName": "Canada",
"required": false,
"type": "String",
"value": "Canada"
},
{
"displayName": "Cape Verde",
"required": false,
"type": "String",
"value": "Cape Verde"
},
{
"displayName": "Cayman Islands",
"required": false,
"type": "String",
"value": "Cayman Islands"
},
{
"displayName": "Central African Republic",
"required": false,
"type": "String",
"value": "Central African Republic"
},
{
"displayName": "Chad",
"required": false,
"type": "String",
"value": "Chad"
},
{
"displayName": "Chile",
"required": false,
"type": "String",
"value": "Chile"
},
{
"displayName": "China",
"required": false,
"type": "String",
"value": "China"
},
{
"displayName": "Christmas Island",
"required": false,
"type": "String",
"value": "Christmas Island"
},
{
"displayName": "Cocos (Keeling) Islands",
"required": false,
"type": "String",
"value": "Cocos (Keeling) Islands"
},
{
"displayName": "Colombia",
"required": false,
"type": "String",
"value": "Colombia"
},
{
"displayName": "Comoros",
"required": false,
"type": "String",
"value": "Comoros"
},
{
"displayName": "Congo",
"required": false,
"type": "String",
"value": "Congo"
},
{
"displayName": "Congo, Democratic Republic",
"required": false,
"type": "String",
"value": "Congo, Democratic Republic"
},
{
"displayName": "Cook Islands",
"required": false,
"type": "String",
"value": "Cook Islands"
},
{
"displayName": "Costa Rica",
"required": false,
"type": "String",
"value": "Costa Rica"
},
{
"displayName": "C�te d'Ivoire",
"required": false,
"type": "String",
"value": "C�te d'Ivoire"
},
{
"displayName": "Croatia",
"required": false,
"type": "String",
"value": "Croatia"
},
{
"displayName": "Cuba",
"required": false,
"type": "String",
"value": "Cuba"
},
{
"displayName": "Cura�ao",
"required": false,
"type": "String",
"value": "Cura�ao"
},
{
"displayName": "Cyprus",
"required": false,
"type": "String",
"value": "Cyprus"
},
{
"displayName": "Czech Republic",
"required": false,
"type": "String",
"value": "Czech Republic"
},
{
"displayName": "Denmark",
"required": false,
"type": "String",
"value": "Denmark"
},
{
"displayName": "Djibouti",
"required": false,
"type": "String",
"value": "Djibouti"
},
{
"displayName": "Dominica",
"required": false,
"type": "String",
"value": "Dominica"
},
{
"displayName": "Dominican Republic",
"required": false,
"type": "String",
"value": "Dominican Republic"
},
{
"displayName": "Ecuador",
"required": false,
"type": "String",
"value": "Ecuador"
},
{
"displayName": "Egypt",
"required": false,
"type": "String",
"value": "Egypt"
},
{
"displayName": "El Salvador",
"required": false,
"type": "String",
"value": "El Salvador"
},
{
"displayName": "Equatorial Guinea",
"required": false,
"type": "String",
"value": "Equatorial Guinea"
},
{
"displayName": "Eritrea",
"required": false,
"type": "String",
"value": "Eritrea"
},
{
"displayName": "Estonia",
"required": false,
"type": "String",
"value": "Estonia"
},
{
"displayName": "Eswatini",
"required": false,
"type": "String",
"value": "Eswatini"
},
{
"displayName": "Ethiopia",
"required": false,
"type": "String",
"value": "Ethiopia"
},
{
"displayName": "Falkland Islands (Malvinas",
"required": false,
"type": "String",
"value": "Falkland Islands (Malvinas"
},
{
"displayName": "Faroe Islands",
"required": false,
"type": "String",
"value": "Faroe Islands"
},
{
"displayName": "Fiji",
"required": false,
"type": "String",
"value": "Fiji"
},
{
"displayName": "Finland",
"required": false,
"type": "String",
"value": "Finland"
},
{
"displayName": "France",
"required": false,
"type": "String",
"value": "France"
},
{
"displayName": "French Guiana",
"required": false,
"type": "String",
"value": "French Guiana"
},
{
"displayName": "French Polynesia",
"required": false,
"type": "String",
"value": "French Polynesia"
},
{
"displayName": "French Southern Territories",
"required": false,
"type": "String",
"value": "French Southern Territories"
},
{
"displayName": "Gabon",
"required": false,
"type": "String",
"value": "Gabon"
},
{
"displayName": "Gambia",
"required": false,
"type": "String",
"value": "Gambia"
},
{
"displayName": "Georgia",
"required": false,
"type": "String",
"value": "Georgia"
},
{
"displayName": "Germany",
"required": false,
"type": "String",
"value": "Germany"
},
{
"displayName": "Ghana",
"required": false,
"type": "String",
"value": "Ghana"
},
{
"displayName": "Gibraltar",
"required": false,
"type": "String",
"value": "Gibraltar"
},
{
"displayName": "Greece",
"required": false,
"type": "String",
"value": "Greece"
},
{
"displayName": "Greenland",
"required": false,
"type": "String",
"value": "Greenland"
},
{
"displayName": "Grenada",
"required": false,
"type": "String",
"value": "Grenada"
},
{
"displayName": "Guadeloupe",
"required": false,
"type": "String",
"value": "Guadeloupe"
},
{
"displayName": "Guam",
"required": false,
"type": "String",
"value": "Guam"
},
{
"displayName": "Guatemala",
"required": false,
"type": "String",
"value": "Guatemala"
},
{
"displayName": "Guernsey",
"required": false,
"type": "String",
"value": "Guernsey"
},
{
"displayName": "Guinea",
"required": false,
"type": "String",
"value": "Guinea"
},
{
"displayName": "Guinea-Bissau",
"required": false,
"type": "String",
"value": "Guinea-Bissau"
},
{
"displayName": "Guyana",
"required": false,
"type": "String",
"value": "Guyana"
},
{
"displayName": "Haiti",
"required": false,
"type": "String",
"value": "Haiti"
},
{
"displayName": "Heard Is. & Mcdonald Islands",
"required": false,
"type": "String",
"value": "Heard Is. & Mcdonald Islands"
},
{
"displayName": "Honduras",
"required": false,
"type": "String",
"value": "Honduras"
},
{
"displayName": "Hong Kong",
"required": false,
"type": "String",
"value": "Hong Kong"
},
{
"displayName": "Hungary",
"required": false,
"type": "String",
"value": "Hungary"
},
{
"displayName": "Iceland",
"required": false,
"type": "String",
"value": "Iceland"
},
{
"displayName": "India",
"required": false,
"type": "String",
"value": "India"
},
{
"displayName": "Indonesia",
"required": false,
"type": "String",
"value": "Indonesia"
},
{
"displayName": "Iran, Islamic Republic of",
"required": false,
"type": "String",
"value": "Iran, Islamic Republic of"
},
{
"displayName": "Iraq",
"required": false,
"type": "String",
"value": "Iraq"
},
{
"displayName": "Ireland",
"required": false,
"type": "String",
"value": "Ireland"
},
{
"displayName": "Isle of Man",
"required": false,
"type": "String",
"value": "Isle of Man"
},
{
"displayName": "Israel",
"required": false,
"type": "String",
"value": "Israel"
},
{
"displayName": "Italy",
"required": false,
"type": "String",
"value": "Italy"
},
{
"displayName": "Jamaica",
"required": false,
"type": "String",
"value": "Jamaica"
},
{
"displayName": "Japan",
"required": false,
"type": "String",
"value": "Japan"
},
{
"displayName": "Jersey",
"required": false,
"type": "String",
"value": "Jersey"
},
{
"displayName": "Jordan",
"required": false,
"type": "String",
"value": "Jordan"
},
{
"displayName": "Kazakhstan",
"required": false,
"type": "String",
"value": "Kazakhstan"
},
{
"displayName": "Kenya",
"required": false,
"type": "String",
"value": "Kenya"
},
{
"displayName": "Kiribati",
"required": false,
"type": "String",
"value": "Kiribati"
},
{
"displayName": "Korea, Republic of",
"required": false,
"type": "String",
"value": "Korea, Republic of"
},
{
"displayName": "Korea, Demo. People's Rep",
"required": false,
"type": "String",
"value": "Korea, Demo. People's Rep"
},
{
"displayName": "Kosovo",
"required": false,
"type": "String",
"value": "Kosovo"
},
{
"displayName": "Kuwait",
"required": false,
"type": "String",
"value": "Kuwait"
},
{
"displayName": "Kyrgyzstan",
"required": false,
"type": "String",
"value": "Kyrgyzstan"
},
{
"displayName": "Lao",
"required": false,
"type": "String",
"value": "Lao"
},
{
"displayName": "Latvia",
"required": false,
"type": "String",
"value": "Latvia"
},
{
"displayName": "Lebanon",
"required": false,
"type": "String",
"value": "Lebanon"
},
{
"displayName": "Lesotho",
"required": false,
"type": "String",
"value": "Lesotho"
},
{
"displayName": "Liberia",
"required": false,
"type": "String",
"value": "Liberia"
},
{
"displayName": "Libyan Arab Jamahiriya",
"required": false,
"type": "String",
"value": "Libyan Arab Jamahiriya"
},
{
"displayName": "Liechtenstein",
"required": false,
"type": "String",
"value": "Liechtenstein"
},
{
"displayName": "Lithuania",
"required": false,
"type": "String",
"value": "Lithuania"
},
{
"displayName": "Luxembourg",
"required": false,
"type": "String",
"value": "Luxembourg"
},
{
"displayName": "Macao",
"required": false,
"type": "String",
"value": "Macao"
},
{
"displayName": "Macedonia",
"required": false,
"type": "String",
"value": "Macedonia"
},
{
"displayName": "Madagascar",
"required": false,
"type": "String",
"value": "Madagascar"
},
{
"displayName": "Malawi",
"required": false,
"type": "String",
"value": "Malawi"
},
{
"displayName": "Malaysia",
"required": false,
"type": "String",
"value": "Malaysia"
},
{
"displayName": "Maldives",
"required": false,
"type": "String",
"value": "Maldives"
},
{
"displayName": "Mali",
"required": false,
"type": "String",
"value": "Mali"
},
{
"displayName": "Malta",
"required": false,
"type": "String",
"value": "Malta"
},
{
"displayName": "Marshall Islands",
"required": false,
"type": "String",
"value": "Marshall Islands"
},
{
"displayName": "Martinique",
"required": false,
"type": "String",
"value": "Martinique"
},
{
"displayName": "Mauritania",
"required": false,
"type": "String",
"value": "Mauritania"
},
{
"displayName": "Mauritius",
"required": false,
"type": "String",
"value": "Mauritius"
},
{
"displayName": "Mayotte",
"required": false,
"type": "String",
"value": "Mayotte"
},
{
"displayName": "Mexico",
"required": false,
"type": "String",
"value": "Mexico"
},
{
"displayName": "Micronesia",
"required": false,
"type": "String",
"value": "Micronesia"
},
{
"displayName": "Moldova, Republic of",
"required": false,
"type": "String",
"value": "Moldova, Republic of"
},
{
"displayName": "Monaco",
"required": false,
"type": "String",
"value": "Monaco"
},
{
"displayName": "Mongolia",
"required": false,
"type": "String",
"value": "Mongolia"
},
{
"displayName": "Montenegro",
"required": false,
"type": "String",
"value": "Montenegro"
},
{
"displayName": "Montserrat",
"required": false,
"type": "String",
"value": "Montserrat"
},
{
"displayName": "Morocco",
"required": false,
"type": "String",
"value": "Morocco"
},
{
"displayName": "Mozambique",
"required": false,
"type": "String",
"value": "Mozambique"
},
{
"displayName": "Myanmar",
"required": false,
"type": "String",
"value": "Myanmar"
},
{
"displayName": "Namibia",
"required": false,
"type": "String",
"value": "Namibia"
},
{
"displayName": "Nauru",
"required": false,
"type": "String",
"value": "Nauru"
},
{
"displayName": "Nepal",
"required": false,
"type": "String",
"value": "Nepal"
},
{
"displayName": "Netherlands",
"required": false,
"type": "String",
"value": "Netherlands"
},
{
"displayName": "Netherlands Antilles",
"required": false,
"type": "String",
"value": "Netherlands Antilles"
},
{
"displayName": "New Caledonia",
"required": false,
"type": "String",
"value": "New Caledonia"
},
{
"displayName": "New Zealand",
"required": false,
"type": "String",
"value": "New Zealand"
},
{
"displayName": "Nicaragua",
"required": false,
"type": "String",
"value": "Nicaragua"
},
{
"displayName": "Niger",
"required": false,
"type": "String",
"value": "Niger"
},
{
"displayName": "Nigeria",
"required": false,
"type": "String",
"value": "Nigeria"
},
{
"displayName": "Niue",
"required": false,
"type": "String",
"value": "Niue"
},
{
"displayName": "Norfolk Island",
"required": false,
"type": "String",
"value": "Norfolk Island"
},
{
"displayName": "Northern Mariana Islands",
"required": false,
"type": "String",
"value": "Northern Mariana Islands"
},
{
"displayName": "Norway",
"required": false,
"type": "String",
"value": "Norway"
},
{
"displayName": "Oman",
"required": false,
"type": "String",
"value": "Oman"
},
{
"displayName": "Pakistan",
"required": false,
"type": "String",
"value": "Pakistan"
},
{
"displayName": "Palau",
"required": false,
"type": "String",
"value": "Palau"
},
{
"displayName": "Palestinian Territory, Occupied",
"required": false,
"type": "String",
"value": "Palestinian Territory, Occupied"
},
{
"displayName": "Panama",
"required": false,
"type": "String",
"value": "Panama"
},
{
"displayName": "Papua New Guinea",
"required": false,
"type": "String",
"value": "Papua New Guinea"
},
{
"displayName": "Paraguay",
"required": false,
"type": "String",
"value": "Paraguay"
},
{
"displayName": "Peru",
"required": false,
"type": "String",
"value": "Peru"
},
{
"displayName": "Philippines",
"required": false,
"type": "String",
"value": "Philippines"
},
{
"displayName": "Pitcairn",
"required": false,
"type": "String",
"value": "Pitcairn"
},
{
"displayName": "Poland",
"required": false,
"type": "String",
"value": "Poland"
},
{
"displayName": "Portugal",
"required": false,
"type": "String",
"value": "Portugal"
},
{
"displayName": "Puerto Rico",
"required": false,
"type": "String",
"value": "Puerto Rico"
},
{
"displayName": "Qatar",
"required": false,
"type": "String",
"value": "Qatar"
},
{
"displayName": "Reunion",
"required": false,
"type": "String",
"value": "Reunion"
},
{
"displayName": "Romania",
"required": false,
"type": "String",
"value": "Romania"
},
{
"displayName": "Russian Federation",
"required": false,
"type": "String",
"value": "Russian Federation"
},
{
"displayName": "Rwanda",
"required": false,
"type": "String",
"value": "Rwanda"
},
{
"displayName": "Saint Barthelemy",
"required": false,
"type": "String",
"value": "Saint Barthelemy"
},
{
"displayName": "Saint Helena",
"required": false,
"type": "String",
"value": "Saint Helena"
},
{
"displayName": "Saint Kitts and Nevis",
"required": false,
"type": "String",
"value": "Saint Kitts and Nevis"
},
{
"displayName": "Saint Lucia",
"required": false,
"type": "String",
"value": "Saint Lucia"
},
{
"displayName": "Saint Martin",
"required": false,
"type": "String",
"value": "Saint Martin"
},
{
"displayName": "Saint Pierre and Miquelon",
"required": false,
"type": "String",
"value": "Saint Pierre and Miquelon"
},
{
"displayName": "Saint Vincent and the Grenadines",
"required": false,
"type": "String",
"value": "Saint Vincent and the Grenadines"
},
{
"displayName": "Samoa",
"required": false,
"type": "String",
"value": "Samoa"
},
{
"displayName": "San Marino",
"required": false,
"type": "String",
"value": "San Marino"
},
{
"displayName": "Sao Tome and Principe",
"required": false,
"type": "String",
"value": "Sao Tome and Principe"
},
{
"displayName": "Saudi Arabia",
"required": false,
"type": "String",
"value": "Saudi Arabia"
},
{
"displayName": "Senegal",
"required": false,
"type": "String",
"value": "Senegal"
},
{
"displayName": "Serbia",
"required": false,
"type": "String",
"value": "Serbia"
},
{
"displayName": "Seychelles",
"required": false,
"type": "String",
"value": "Seychelles"
},
{
"displayName": "Sierra Leone",
"required": false,
"type": "String",
"value": "Sierra Leone"
},
{
"displayName": "Singapore",
"required": false,
"type": "String",
"value": "Singapore"
},
{
"displayName": "Sint Maarten",
"required": false,
"type": "String",
"value": "Sint Maarten"
},
{
"displayName": "Slovakia",
"required": false,
"type": "String",
"value": "Slovakia"
},
{
"displayName": "Slovenia",
"required": false,
"type": "String",
"value": "Slovenia"
},
{
"displayName": "Solomon Islands",
"required": false,
"type": "String",
"value": "Solomon Islands"
},
{
"displayName": "Somalia",
"required": false,
"type": "String",
"value": "Somalia"
},
{
"displayName": "South Africa",
"required": false,
"type": "String",
"value": "South Africa"
},
{
"displayName": "S. Georgia & S. Sandwich Is",
"required": false,
"type": "String",
"value": "S. Georgia & S. Sandwich Is"
},
{
"displayName": "Spain",
"required": false,
"type": "String",
"value": "Spain"
},
{
"displayName": "Sri Lanka",
"required": false,
"type": "String",
"value": "Sri Lanka"
},
{
"displayName": "Sudan",
"required": false,
"type": "String",
"value": "Sudan"
},
{
"displayName": "South Sudan",
"required": false,
"type": "String",
"value": "South Sudan"
},
{
"displayName": "Suriname",
"required": false,
"type": "String",
"value": "Suriname"
},
{
"displayName": "Svalbard and Jan Mayen",
"required": false,
"type": "String",
"value": "Svalbard and Jan Mayen"
},
{
"displayName": "Sweden",
"required": false,
"type": "String",
"value": "Sweden"
},
{
"displayName": "Switzerland",
"required": false,
"type": "String",
"value": "Switzerland"
},
{
"displayName": "Syrian Arab Republic",
"required": false,
"type": "String",
"value": "Syrian Arab Republic"
},
{
"displayName": "Taiwan",
"required": false,
"type": "String",
"value": "Taiwan"
},
{
"displayName": "Tajikistan",
"required": false,
"type": "String",
"value": "Tajikistan"
},
{
"displayName": "Tanzania, United Republic of",
"required": false,
"type": "String",
"value": "Tanzania, United Republic of"
},
{
"displayName": "Thailand",
"required": false,
"type": "String",
"value": "Thailand"
},
{
"displayName": "Timor-Leste",
"required": false,
"type": "String",
"value": "Timor-Leste"
},
{
"displayName": "Togo",
"required": false,
"type": "String",
"value": "Togo"
},
{
"displayName": "Tokelau",
"required": false,
"type": "String",
"value": "Tokelau"
},
{
"displayName": "Tonga",
"required": false,
"type": "String",
"value": "Tonga"
},
{
"displayName": "Trinidad and Tobago",
"required": false,
"type": "String",
"value": "Trinidad and Tobago"
},
{
"displayName": "Tunisia",
"required": false,
"type": "String",
"value": "Tunisia"
},
{
"displayName": "Turkey",
"required": false,
"type": "String",
"value": "Turkey"
},
{
"displayName": "Turkmenistan",
"required": false,
"type": "String",
"value": "Turkmenistan"
},
{
"displayName": "Turks and Caicos Islands",
"required": false,
"type": "String",
"value": "Turks and Caicos Islands"
},
{
"displayName": "Tuvalu",
"required": false,
"type": "String",
"value": "Tuvalu"
},
{
"displayName": "Uganda",
"required": false,
"type": "String",
"value": "Uganda"
},
{
"displayName": "Ukraine",
"required": false,
"type": "String",
"value": "Ukraine"
},
{
"displayName": "United Arab Emirates",
"required": false,
"type": "String",
"value": "United Arab Emirates"
},
{
"displayName": "United Kingdom",
"required": false,
"type": "String",
"value": "United Kingdom"
},
{
"displayName": "US Minor Outlying Islands",
"required": false,
"type": "String",
"value": "US Minor Outlying Islands"
},
{
"displayName": "Uruguay",
"required": false,
"type": "String",
"value": "Uruguay"
},
{
"displayName": "Uzbekistan",
"required": false,
"type": "String",
"value": "Uzbekistan"
},
{
"displayName": "Vanuatu",
"required": false,
"type": "String",
"value": "Vanuatu"
},
{
"displayName": "Vatican City State",
"required": false,
"type": "String",
"value": "Vatican City State"
},
{
"displayName": "Venezuela",
"required": false,
"type": "String",
"value": "Venezuela"
},
{
"displayName": "Vietnam",
"required": false,
"type": "String",
"value": "Vietnam"
},
{
"displayName": "Virgin Islands, British",
"required": false,
"type": "String",
"value": "Virgin Islands, British"
},
{
"displayName": "Virgin Islands, U.S",
"required": false,
"type": "String",
"value": "Virgin Islands, U.S"
},
{
"displayName": "Wallis and Futuna",
"required": false,
"type": "String",
"value": "Wallis and Futuna"
},
{
"displayName": "Western Sahara",
"required": false,
"type": "String",
"value": "Western Sahara"
},
{
"displayName": "Yemen",
"required": false,
"type": "String",
"value": "Yemen"
},
{
"displayName": "Zambia",
"required": false,
"type": "String",
"value": "Zambia"
},
{
"displayName": "Zimbabwe",
"required": false,
"type": "String",
"value": "Zimbabwe"
}
],
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Required if TaxNumber is supplied",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 200 characters",
"field": "Addresses.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 200 characters",
"field": "Addresses.Line2"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 30 characters",
"field": "Addresses.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 40 characters",
"field": "Addresses.Region"
}
]
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "If supplied, must contain only 1 address",
"field": "Addresses"
},
{
"details": "If TaxNumber is supplied, an Address with a Country is required",
"field": "Addresses"
}
]
}
},
"contactName": {
"description": "The name of the main contact for the customer",
"displayName": "Contact Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be between 1 and 200 characters",
"field": "ContactName"
}
]
}
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be between 1 and 100 characters",
"field": "CustomerName"
}
]
}
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the customer",
"displayName": "Default Currency",
"options": [
{
"displayName": "Australian Dollar",
"required": false,
"type": "String",
"value": "AUD"
},
{
"displayName": "Canadian Dollar",
"required": false,
"type": "String",
"value": "CAD"
},
{
"displayName": "Pound Sterling",
"required": false,
"type": "String",
"value": "GBP"
},
{
"displayName": "US Dollar",
"required": false,
"type": "String",
"value": "USD"
},
{
"displayName": "Rand",
"required": false,
"type": "String",
"value": "ZAR"
}
],
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 200 characters",
"field": "EmailAddress"
}
]
}
},
"id": {
"description": "The identifier for the customer, unique for the company",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Required if auto-numbering is not enabled for the Sage Intacct company",
"field": "Id"
}
]
}
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 30 characters",
"field": "Phone"
}
]
}
},
"status": {
"description": "The current state of the customer",
"displayName": "Customer Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 20 characters",
"field": "TaxNumber"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": true,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": true,
"type": "String"
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": true,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": true,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": true,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": true,
"type": "String"
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"contactName": {
"description": "The name of the main contact for the customer",
"displayName": "Contact Name",
"required": true,
"type": "String"
},
"contacts": {
"description": "A collection of alternative contacts for the customer",
"displayName": "Contacts",
"properties": {
"address": {
"description": "The address for the contact",
"displayName": "Address",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": true,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": true,
"type": "String"
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": true,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": true,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": true,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": true,
"type": "String"
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"email": {
"description": "The email address for the contact",
"displayName": "Email",
"required": true,
"type": "String"
},
"modifiedDate": {
"description": "The date the record was last updated in the system cache",
"displayName": "Modified Date",
"required": true,
"type": "DateTime"
},
"name": {
"description": "The name of the contact",
"displayName": "Name",
"required": true,
"type": "String"
},
"phone": {
"description": "A collection of phone numbers for the contact",
"displayName": "Phone",
"properties": {
"number": {
"description": "The full number including country, and area code where applicable",
"displayName": "Number",
"required": true,
"type": "String"
},
"type": {
"description": "The type of phone number",
"displayName": "Phone Type",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"status": {
"description": "The current state of the contact",
"displayName": "Contact Status",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String"
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the customer",
"displayName": "Default Currency",
"required": true,
"type": "String"
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": true,
"type": "String"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": true,
"type": "String"
},
"registrationNumber": {
"description": "The customer's registration number",
"displayName": "Registration Number",
"required": true,
"type": "String"
},
"status": {
"description": "The current state of the customer",
"displayName": "Customer Status",
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A customer is a person or organisation who buys goods or services",
"displayName": "Customer",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the customer",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 255 characters.",
"field": "Addresses.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 50 characters.",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "Addresses.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "Addresses.Line2"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only English alphabet characters are permitted.",
"field": "Addresses.PostalCode"
},
{
"details": "Max length of 50 characters.",
"field": "Addresses.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 255 characters.",
"field": "Addresses.Region"
}
]
}
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Billing Address",
"required": false,
"type": "String",
"value": "Billing"
},
{
"displayName": "Delivery Address",
"required": false,
"type": "String",
"value": "Delivery"
}
],
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Billing = POBOX, Delivery/Unknown = STREET",
"field": "Addresses.Type"
}
]
}
}
},
"required": false,
"type": "Array"
},
"customerName": {
"description": "The name for the customer, typically a company name",
"displayName": "Customer Name",
"required": true,
"type": "String"
},
"emailAddress": {
"description": "The preferred Email address the customer should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the customer should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Country, area, and number are space separated",
"field": "Phone"
}
]
}
},
"registrationNumber": {
"description": "The customer's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 50 characters.",
"field": "RegistrationNumber"
}
]
}
},
"status": {
"description": "The current state of the customer",
"displayName": "Customer Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Inactive",
"required": false,
"type": "String",
"value": "InActive"
}
],
"required": false,
"type": "String"
},
"taxNumber": {
"description": "The customer's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}
GET
Get customer attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentIdhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments/:attachmentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get customer
{{baseUrl}}/companies/:companyId/data/customers/:customerId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/customers/:customerId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/customers/:customerId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/customers/:customerId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/customers/:customerId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/customers/:customerId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/customers/:customerId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/customers/:customerId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/customers/:customerId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/customers/:customerId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/customers/:customerId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/customers/:customerId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/customers/:customerId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/customers/:customerId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/customers/:customerId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/customers/:customerId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/customers/:customerId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/customers/:customerId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/customers/:customerId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/customers/:customerId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/customers/:customerId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/customers/:customerId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/customers/:customerId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/customers/:customerId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/customers/:customerId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/customers/:customerId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/customers/:customerId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/customers/:customerId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/customers/:customerId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/customers/:customerId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/customers/:customerId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/customers/:customerId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/customers/:customerId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/customers/:customerId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/customers/:customerId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/customers/:customerId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/customers/:customerIdhttp GET {{baseUrl}}/companies/:companyId/data/customers/:customerIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/customers/:customerIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/customers/:customerId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List customer attachments
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachmentshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachmentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachmentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/customers/:customerId/attachments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List customers
{{baseUrl}}/companies/:companyId/data/customers
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/customers?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/customers" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/customers?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/customers?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/customers?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/customers?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/customers?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/customers?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/customers?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/customers?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/customers?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/customers?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/customers',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/customers?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/customers?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/customers?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/customers?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/customers',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/customers');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/customers',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/customers?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/customers?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/customers?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/customers?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/customers?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/customers');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/customers');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/customers?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/customers?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/customers?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/customers"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/customers"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/customers?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/customers') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/customers";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/customers?page='http GET '{{baseUrl}}/companies/:companyId/data/customers?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/customers?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/customers?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Update customer
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/companies/:companyId/connections/:connectionId/push/customers/:customerId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/customers/:customerId',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/companies/:companyId/connections/:connectionId/push/customers/:customerId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId"
payload = {}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId"
payload <- "{}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/companies/:companyId/connections/:connectionId/push/customers/:customerId') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http PUT {{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerIdimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/customers/:customerId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create direct cost
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/directCosts HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/directCosts',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/directCosts", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/directCosts') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCostsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Download direct cost attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download
QUERY PARAMS
attachmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/downloadhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/downloadwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/downloadimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId/download")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create direct cost model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/directCosts HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/directCosts',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/directCosts")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/directCosts') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCostshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCostswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCostsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directCosts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "",
"displayName": "Direct Cost",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "ContactRef"
}
],
"warnings": []
}
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If unspecified, base currency is assumed. Must agree with the bank account in PaymentAllocations",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if the currency is not the base currency",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "AccountRef.Name"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String"
},
"discountAmount": {
"description": "The value, in the given currency, of any discounts applied",
"displayName": "Discount Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "LineItems.DiscountAmount"
}
],
"warnings": []
}
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "LineItems.DiscountPercentage"
}
],
"warnings": []
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "LineItems.ItemRef"
}
],
"warnings": []
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if totalAmount is not specified",
"field": "LineItems.SubTotal"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "LineItems.TaxAmount"
}
],
"warnings": []
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "TaxRateRef.EffectiveTaxRate"
}
],
"warnings": []
}
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "TaxRateRef.Name"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if subTotal is not specified",
"field": "LineItems.TotalAmount"
}
],
"warnings": []
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "LineItems.TrackingCategoryRefs"
}
],
"warnings": []
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Only one line is supported",
"field": "LineItems"
}
]
}
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "Note"
}
],
"warnings": []
}
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "Allocation.AllocatedOnDate"
}
],
"warnings": []
}
},
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "Allocation.Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the transaction",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "Allocation.CurrencyRate"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "Allocation.TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "AccountRef.Name"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "Payment.Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "Payment.CurrencyRate"
}
],
"warnings": []
}
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "Payment.PaidOnDate"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "Payment.TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Only one line is supported",
"field": "PaymentAllocations"
}
]
}
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String"
},
"subTotal": {
"description": "The total amount of the direct transaction excluding any taxes",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "SubTotal"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The total amount of tax on the direct transaction",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "TaxAmount"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The amount of the direct transaction, inclusive of tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "is not supported and will be ignored",
"field": "TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "",
"displayName": "Direct Cost",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "is not supported by FreeAgent and will be ignored on push. ",
"field": "ContactRef.DataType"
}
]
}
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "is not supported by FreeAgent and will be ignored on push. ",
"field": "ContactRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "CurrencyRate"
}
]
}
},
"id": {
"description": "The identifier for the direct transaction, unique to the company",
"displayName": "Unique Direct Transaction ID",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "Id"
}
]
}
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "must be provided",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "must be provided",
"field": "AccountRef.Id"
}
],
"warnings": []
}
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "AccountRef.Name"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "If a Note is provided, this field will be ignored on push. ",
"field": "LineItems.Description"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "LineItems.Quantity"
}
]
}
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "TaxRateRef.EffectiveTaxRate"
}
]
}
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "TaxRateRef.Id"
}
]
}
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "TaxRateRef.Name"
}
]
}
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "LineItems.UnitAmount"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Exactly one line item must be specified",
"field": "LineItems"
}
]
}
},
"modifiedDate": {
"description": "The date the record was last updated in the system cache",
"displayName": "Modified Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "ModifiedDate"
}
]
}
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "must be provided",
"field": "Note"
}
],
"warnings": []
}
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": false,
"type": "DateTime"
},
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the transaction",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": false,
"type": "Number"
}
},
"required": false,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "must be provided",
"field": "AccountRef.Id"
}
],
"warnings": []
}
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "AccountRef.Name"
}
]
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"id": {
"description": "The identifier for the allocated payment",
"displayName": "Identifier",
"required": false,
"type": "String"
},
"note": {
"description": "Any additional text based information associated with the allocated payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": false,
"type": "DateTime"
},
"reference": {
"description": "Reference associated with the allocated payment",
"displayName": "Reference",
"required": false,
"type": "String"
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array"
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "is not supported by FreeAgent and will not be mapped. ",
"field": "Reference"
}
]
}
},
"sourceModifiedDate": {
"description": "The date the record was last changed in the originating system",
"displayName": "Source Modified Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "SourceModifiedDate"
}
]
}
},
"subTotal": {
"description": "The total amount of the direct transaction excluding any taxes",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"taxAmount": {
"description": "The total amount of tax on the direct transaction",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"totalAmount": {
"description": "The amount of the direct transaction, inclusive of tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Cost",
"displayName": "Direct Cost",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not be a bank account",
"field": "LineItems.AccountRef"
},
{
"details": "Should only be specified when pushing an expense",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Should only be specified when pushing an item (not an expense)",
"field": "LineItems.ItemRef"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Should be specified when item type is not 'Discount'",
"field": "LineItems.TaxRateRef"
}
]
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Should have the same sign across all line items",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account of type 'Bank' OR type 'Credit Card'",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must contain a single allocation",
"field": "PaymentAllocations"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Cost",
"displayName": "Direct Cost",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"required": false,
"type": "Object"
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the default currency",
"field": "Currency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code",
"field": "Currency"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.",
"field": "CurrencyRate"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"required": true,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"modifiedDate": {
"description": "The date the record was last updated in the system cache",
"displayName": "Modified Date",
"required": false,
"type": "DateTime"
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4096 characters.",
"field": "Note"
}
]
}
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "The account in which to make the deposit",
"field": "Payment.AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the allocated payment",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"note": {
"description": "Any additional text based information associated with the allocated payment",
"displayName": "Note",
"required": true,
"type": "String"
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime"
},
"reference": {
"description": "Reference associated with the allocated payment",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Use to reference the check number of this deposit.",
"field": "Payment.Reference"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must contain a single payment allocation",
"field": "PaymentAllocations"
}
]
}
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Represents the check number",
"field": "Reference"
}
]
}
},
"sourceModifiedDate": {
"description": "The date the record was last changed in the originating system",
"displayName": "Source Modified Date",
"required": false,
"type": "DateTime"
},
"subTotal": {
"description": "The total amount of the direct transaction excluding any taxes",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"taxAmount": {
"description": "The total amount of tax on the direct transaction",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The amount of the direct transaction, inclusive of tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Cost",
"displayName": "Direct Cost",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "Suppliers",
"required": false,
"type": "String",
"value": "Suppliers"
}
],
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "If the issue date is not supplied, the current date on the server is used.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be an Expense or Income account",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be set if ItemRef is not",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be less than 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be set if AccountRef is not",
"field": "LineItems.ItemRef"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be specified on all line items or none. If specified will override QBO tax calculations.",
"field": "LineItems.TaxAmount"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used.",
"field": "TaxRateRef.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Required for all companies except QuickBooks Online France companies.",
"field": "LineItems.TaxRateRef"
}
]
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid Id",
"field": "TrackingCategoryRefs.TrackingCategoryRefs"
}
]
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Only one tracking category of type CLASS can be provided per item.",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "Only one tracking category of type DEPARTMENT can be provided per invoice.",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "All DEPARTMENT tracking categories must be the same",
"field": "LineItems.TrackingCategoryRefs"
}
]
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the Currency of the company",
"field": "Allocation.Currency"
}
]
}
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of the line items",
"field": "Allocation.TotalAmount"
}
]
}
}
},
"required": false,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be Bank, Cash or Asset account",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the Currency of the company",
"field": "Payment.Currency"
}
]
}
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of the line items",
"field": "Payment.TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have exactly one payment allocation.",
"field": "PaymentAllocations"
}
]
}
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be less than 22 characters.",
"field": "Reference"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Cost",
"displayName": "Direct Cost",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "Suppliers",
"required": false,
"type": "String",
"value": "Suppliers"
}
],
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "If the issue date is not supplied, the current date on the server is used.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be an Expense or Income account",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be set if ItemRef is not",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be less than 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be set if AccountRef is not",
"field": "LineItems.ItemRef"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be specified on all line items or none. If specified will override QBO tax calculations.",
"field": "LineItems.TaxAmount"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used.",
"field": "TaxRateRef.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Required for all companies except QuickBooks Online France companies.",
"field": "LineItems.TaxRateRef"
}
]
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid Id",
"field": "TrackingCategoryRefs.TrackingCategoryRefs"
}
]
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Only one tracking category of type CLASS can be provided per item.",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "Only one tracking category of type DEPARTMENT can be provided per invoice.",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "All DEPARTMENT tracking categories must be the same",
"field": "LineItems.TrackingCategoryRefs"
}
]
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the Currency of the company",
"field": "Allocation.Currency"
}
]
}
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of the line items",
"field": "Allocation.TotalAmount"
}
]
}
}
},
"required": false,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be Bank, Cash or Asset account",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the Currency of the company",
"field": "Payment.Currency"
}
]
}
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of the line items",
"field": "Payment.TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have exactly one payment allocation.",
"field": "PaymentAllocations"
}
]
}
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be less than 22 characters.",
"field": "Reference"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Cost",
"displayName": "Direct Cost",
"properties": {
"accountRef": {
"description": "The bank account to pay this direct cost from.",
"displayName": "Bank Account",
"properties": {
"id": {
"description": "Nominal code of the bank account.",
"displayName": "Account Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing bank account and have a max length of 8 characters.",
"field": "accountRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency in which the direct cost is issued in.",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "This must match the target account's default currency.",
"field": "currency"
}
]
}
},
"currencyRate": {
"description": "The currency rate associated with this transaction.",
"displayName": "Currency Rate",
"required": true,
"type": "Number"
},
"issueDate": {
"description": "The date this payment was issued.",
"displayName": "Issue Date",
"required": true,
"type": "Number"
},
"lineItems": {
"description": "Line items of the direct cost.",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Target bank account for the direct cost line item.",
"displayName": "Nominal Code",
"properties": {
"id": {
"description": "The ID of the Account the line is linked to.",
"displayName": "Id",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Description of the direct cost line item.",
"displayName": "description",
"required": false,
"type": "String"
},
"quantity": {
"description": "Quantity for the direct cost line item.",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be 1 or -1.",
"field": "LineItems.quantity"
}
]
}
},
"subTotal": {
"description": "Amount for the direct cost line item. Debit entries are considered positive, and credit entries are considered negative.",
"displayName": "Net Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Cannot have both subtotal and tax amount as 0 for line item.",
"field": "LineItems.subTotal"
}
]
}
},
"taxAmount": {
"description": "Tax amount for the direct cost line item.",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Cannot have both tax amount and subtotal as 0 for line item.",
"field": "LineItems.taxAmount"
}
]
}
},
"taxCode": {
"description": "The tax code ID associated with this transaction.",
"displayName": "Tax Code Id",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "Total amount for the direct cost line item.",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Will be auto populated using tax amount and net amount.",
"field": "LineItems.totalAmount"
}
],
"warnings": []
}
},
"trackingCategoryRefs": {
"description": "Tracking categories associated with this transaction.",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The ID of the tracking category associated with the transaction",
"displayName": "Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "A department is required. If a project reference is provided, the cost code for that project must also be provided.",
"field": "id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"unitAmount": {
"description": "Unit amount for the direct cost line item.",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Cannot equal 0 and will be set to Net amount if not provided accordingly.",
"field": "LineItems.unitAmount"
}
]
}
}
},
"required": true,
"type": "Array"
},
"reference": {
"description": "The user reference for this direct cost.",
"displayName": "Reference",
"required": false,
"type": "String"
},
"subTotal": {
"description": "The net amount being paid in this direct cost.",
"displayName": "Sub Total",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "This must equal the sum of the line net amounts"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The tax amount being paid in this direct cost.",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "This must equal the sum of the line tax amounts"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount being paid in this direct cost.",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "This must equal the sum of the line amounts"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Cost",
"displayName": "Direct Cost",
"properties": {
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not contain no more than 1000 characters.",
"field": "LineItems.Description"
}
],
"warnings": []
}
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be an existing tax rate in Sage Intacct.",
"field": "TaxRateRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": false,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must contain at least one line item.",
"field": "LineItems"
}
],
"warnings": []
}
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be used to provide payee's name and contain no more than 80 characters.",
"field": "Note"
}
],
"warnings": []
}
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If provided, must match the sum of the line items.",
"field": "Allocation.TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime"
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If provided, must match the sum of the line items.",
"field": "Payment.TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must contain a single allocation.",
"field": "PaymentAllocations"
}
],
"warnings": []
}
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not contain no more than 45 characters.",
"field": "Reference"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The amount of the direct transaction, inclusive of tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If provided, must match the sum of the line items.",
"field": "TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Cost",
"displayName": "Direct Cost",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String"
},
"discountAmount": {
"description": "The value, in the given currency, of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the item referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"tracking": {
"description": "Information this item is being tracked against",
"displayName": "Tracking",
"properties": {
"invoiceTo": {
"description": "The entity the record should be invoiced to",
"displayName": "Invoice To",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"recordRefs": {
"description": "A collection of records this item is being tracked against",
"displayName": "Record References",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": true,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the transaction",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the allocated payment",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"note": {
"description": "Any additional text based information associated with the allocated payment",
"displayName": "Note",
"required": true,
"type": "String"
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime"
},
"reference": {
"description": "Reference associated with the allocated payment",
"displayName": "Reference",
"required": true,
"type": "String"
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array"
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": true,
"type": "String"
},
"subTotal": {
"description": "The total amount of the direct transaction excluding any taxes",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "The total amount of tax on the direct transaction",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The amount of the direct transaction, inclusive of tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Cost",
"displayName": "Direct Cost",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "ContactRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "ContactRef.Id"
},
{
"details": "Must match the ID of an existing contact.",
"field": "ContactRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "ContactRef"
}
],
"warnings": []
}
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.AccountRef"
}
],
"warnings": []
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 4000 characters long.",
"field": "LineItems.Description"
}
],
"warnings": []
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "ItemRef.Id"
},
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TaxAmount"
}
],
"warnings": []
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not provided, will be set to the default tax rate for the line's account.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax rate.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "When one line is negative, all lines must be negative.",
"field": "LineItems.TotalAmount"
}
],
"warnings": [
{
"details": "When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.",
"field": "LineItems.TotalAmount"
}
]
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TrackingCategoryRefs.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Tracking categories must not have the same parent tracking category.",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "Maximum of 2 Tracking Categories.",
"field": "LineItems.TrackingCategoryRefs"
}
],
"warnings": []
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Allocation.TotalAmount"
}
],
"warnings": [
{
"details": "Must be equal to the sum of line items.",
"field": "Allocation.TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "PaymentAllocations.Allocation"
}
],
"warnings": []
}
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a bank account.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing bank account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Payment.AccountRef"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "PaymentAllocations.Payment"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "PaymentAllocations"
}
],
"warnings": []
}
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not exceed 255 characters.",
"field": "Reference"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The total amount of tax on the direct transaction",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TaxAmount"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The amount of the direct transaction, inclusive of tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "When negative, the push item will be converted to a DirectIncome and will be pushed accordingly."
}
]
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Cost",
"displayName": "Direct Cost",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "Required when pushing a negative direct cost & should reference either a Customer or Supplier when provided",
"field": "ContactRef"
}
],
"warnings": []
}
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Is required when pushing a negative direct cost",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Should be provided when TotalAmount is not provided",
"field": "LineItems.SubTotal"
}
],
"warnings": []
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Should be provided when SubTotal is not provided",
"field": "LineItems.TotalAmount"
}
],
"warnings": []
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Is required when pushing a negative direct cost",
"field": "Allocation.Currency"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Is required when pushing a negative direct cost",
"field": "Payment.Currency"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array"
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}
GET
Get direct cost attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId
QUERY PARAMS
attachmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentIdhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments/:attachmentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get direct cost
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostIdhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List direct cost attachments
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachmentshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachmentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachmentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts/:directCostId/attachments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List direct costs
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/directCosts?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/directCosts') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page='http GET '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directCosts?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Upload direct cost attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment"
response = HTTP::Client.post url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment")
.post(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment")
.post(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment' -Method POST $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment' -Method POST import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment"
response = requests.post(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachmenthttp POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachmentwget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachmentimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directCosts/:directCostId/attachment")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create direct income attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment
QUERY PARAMS
directIncomeId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment"
response = HTTP::Client.post url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment")
.post(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment")
.post(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment' -Method POST $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment' -Method POST import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment"
response = requests.post(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachmenthttp POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachmentwget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachmentimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes/:directIncomeId/attachment")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create direct income
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/directIncomes HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/directIncomes',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/directIncomes", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/directIncomes') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomesimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/directIncomes")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Download direct income attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download
QUERY PARAMS
attachmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/downloadhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/downloadwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/downloadimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId/download")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create direct income model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/directIncomes HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/directIncomes',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/directIncomes")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/directIncomes') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomeshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomeswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/directIncomes")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Income",
"displayName": "Direct Income",
"properties": {
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be the same as the PaymentAllocation.Payment.AccountRef.Id currency",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if LineItems.TotalAmount is not provided",
"field": "LineItems.SubTotal"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if LineItems.SubTotal is not provided",
"field": "LineItems.TotalAmount"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Only one line is supported",
"field": "LineItems"
}
]
}
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be a Bank Account ID",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Only one line is supported",
"field": "PaymentAllocations"
}
]
}
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not exceed 20 characters",
"field": "Reference"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Income",
"displayName": "Direct Income",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "is not supported by FreeAgent and will be ignored on push. ",
"field": "ContactRef.DataType"
}
]
}
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "is not supported by FreeAgent and will be ignored on push. ",
"field": "ContactRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "CurrencyRate"
}
]
}
},
"id": {
"description": "The identifier for the direct transaction, unique to the company",
"displayName": "Unique Direct Transaction ID",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "Id"
}
]
}
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "must be provided",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "must be provided",
"field": "AccountRef.Id"
}
],
"warnings": []
}
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "AccountRef.Name"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "If a Note is provided, this field will be ignored on push. ",
"field": "LineItems.Description"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "LineItems.Quantity"
}
]
}
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "TaxRateRef.EffectiveTaxRate"
}
]
}
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "TaxRateRef.Id"
}
]
}
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "TaxRateRef.Name"
}
]
}
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "LineItems.UnitAmount"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Exactly one line item must be specified",
"field": "LineItems"
}
]
}
},
"modifiedDate": {
"description": "The date the record was last updated in the system cache",
"displayName": "Modified Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "ModifiedDate"
}
]
}
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "must be provided",
"field": "Note"
}
],
"warnings": []
}
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": false,
"type": "DateTime"
},
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the transaction",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": false,
"type": "Number"
}
},
"required": false,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "must be provided",
"field": "AccountRef.Id"
}
],
"warnings": []
}
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "AccountRef.Name"
}
]
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"id": {
"description": "The identifier for the allocated payment",
"displayName": "Identifier",
"required": false,
"type": "String"
},
"note": {
"description": "Any additional text based information associated with the allocated payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": false,
"type": "DateTime"
},
"reference": {
"description": "Reference associated with the allocated payment",
"displayName": "Reference",
"required": false,
"type": "String"
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array"
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "is not supported by FreeAgent and will not be mapped. ",
"field": "Reference"
}
]
}
},
"sourceModifiedDate": {
"description": "The date the record was last changed in the originating system",
"displayName": "Source Modified Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "will be ignored on push. ",
"field": "SourceModifiedDate"
}
]
}
},
"subTotal": {
"description": "The total amount of the direct transaction excluding any taxes",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"taxAmount": {
"description": "The total amount of tax on the direct transaction",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"totalAmount": {
"description": "The amount of the direct transaction, inclusive of tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Income",
"displayName": "Direct Income",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Should have the same sign across all line items",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account of type 'Bank'",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must contain a single allocation",
"field": "PaymentAllocations"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Income",
"displayName": "Direct Income",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"required": false,
"type": "Object"
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the default currency",
"field": "Currency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code",
"field": "Currency"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.",
"field": "CurrencyRate"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"id": {
"description": "The identifier for the direct transaction, unique to the company",
"displayName": "Unique Direct Transaction ID",
"required": true,
"type": "String"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must contain a single line item",
"field": "LineItems"
}
]
}
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 100 characters.",
"field": "Note"
}
]
}
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "The account in which to make the deposit",
"field": "Payment.AccountRef"
}
],
"warnings": []
}
},
"id": {
"description": "The identifier for the allocated payment",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"reference": {
"description": "Reference associated with the allocated payment",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Use to reference the check number of this deposit.",
"field": "Payment.Reference"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must contain a single payment allocation",
"field": "PaymentAllocations"
}
]
}
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Represents the check number",
"field": "Reference"
}
]
}
},
"sourceModifiedDate": {
"description": "The date the record was last changed in the originating system",
"displayName": "Source Modified Date",
"required": false,
"type": "DateTime"
},
"totalAmount": {
"description": "The amount of the direct transaction, inclusive of tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Income",
"displayName": "Direct Income",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "Customers",
"required": false,
"type": "String",
"value": "Customers"
}
],
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a Customer reference",
"field": "ContactRef"
}
]
}
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be less than 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must equal the Quantity multiplied by the UnitAmount.",
"field": "LineItems.SubTotal"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "For UK companies, if a value of NON is provided on all lines the directIncomes will be set to have No VAT.",
"field": "TaxRateRef.Id"
},
{
"details": "If an organisation has Automated Sales Tax enabled for US locales, then 'TAX' (Automated Sales Tax), 'NON' (no tax) or a custom tax rate can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "For UK companies, cannot have a mix of NON and valid tax rate IDs.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "All DEPARTMENT tracking categories must be the same",
"field": "LineItems.TrackingCategoryRefs"
}
]
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Required for refunds",
"field": "AccountRef.Id"
},
{
"details": "Must be Bank or Asset account",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Object"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must have exactly one payment allocation.",
"field": "PaymentAllocations"
}
]
}
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be less than 22 characters.",
"field": "Reference"
}
]
}
},
"taxAmount": {
"description": "The total amount of tax on the direct transaction",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Tax will not be overridden if TaxAmount is 0.",
"field": "TaxAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Automated Sales Tax is disabled for this company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Income",
"displayName": "Direct Income",
"properties": {
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be used to provide an account id not linked to a bank account.",
"field": "LineItems.AccountRef"
}
],
"warnings": []
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not contain more than 1000 characters.",
"field": "LineItems.Description"
}
],
"warnings": []
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be an existing tax rate in Sage Intacct.",
"field": "TaxRateRef.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "It is only required for VAT enabled transactions.",
"field": "LineItems.TaxRateRef"
}
],
"warnings": []
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": false,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must contain at least one line item.",
"field": "LineItems"
}
],
"warnings": []
}
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be used to provide bank account id.",
"field": "Payment.AccountRef"
}
],
"warnings": []
}
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must contain a single payment allocation.",
"field": "PaymentAllocations"
}
],
"warnings": []
}
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be used to provide payee's name and contain no more than 80 characters.",
"field": "Reference"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Income",
"displayName": "Direct Income",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String"
},
"discountAmount": {
"description": "The value, in the given currency, of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the item referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"note": {
"description": "The note attached to the direct transaction",
"displayName": "Note",
"required": true,
"type": "String"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the transaction",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the allocated payment",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"note": {
"description": "Any additional text based information associated with the allocated payment",
"displayName": "Note",
"required": true,
"type": "String"
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime"
},
"reference": {
"description": "Reference associated with the allocated payment",
"displayName": "Reference",
"required": true,
"type": "String"
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array"
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": true,
"type": "String"
},
"subTotal": {
"description": "The total amount of the direct transaction excluding any taxes",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "The total amount of tax on the direct transaction",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The amount of the direct transaction, inclusive of tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Direct Income",
"displayName": "Direct Income",
"properties": {
"contactRef": {
"description": "The contact associated with the direct transaction, if known",
"displayName": "Contact Ref",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "ContactRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "ContactRef.Id"
},
{
"details": "Must match the ID of an existing contact.",
"field": "ContactRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "ContactRef"
}
],
"warnings": []
}
},
"currency": {
"description": "The currency of the direct transaction",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the direct transaction and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"issueDate": {
"description": "The date the direct transaction was issued",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the direct transaction",
"displayName": "Direct Transaction Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.AccountRef"
}
],
"warnings": []
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 4000 characters long.",
"field": "LineItems.Description"
}
],
"warnings": []
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "ItemRef.Id"
},
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tax rate.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "When one line is negative, all lines must be negative.",
"field": "LineItems.TotalAmount"
}
],
"warnings": [
{
"details": "When negative, the push item will be converted to a DirectCost and will be pushed accordingly.",
"field": "LineItems.TotalAmount"
}
]
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TrackingCategoryRefs.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Tracking categories must not have the same parent tracking category.",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "Maximum of 2 Tracking Categories.",
"field": "LineItems.TrackingCategoryRefs"
}
],
"warnings": []
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"paymentAllocations": {
"description": "A collection of payments allocated to the direct transaction",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Allocation.TotalAmount"
}
],
"warnings": [
{
"details": "Must be equal to the sum of line items.",
"field": "Allocation.TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "PaymentAllocations.Allocation"
}
],
"warnings": []
}
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a bank account.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing bank account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Payment.AccountRef"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "PaymentAllocations.Payment"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "PaymentAllocations"
}
],
"warnings": []
}
},
"reference": {
"description": "User friendly reference for the direct transaction",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not exceed 255 characters.",
"field": "Reference"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The total amount of tax on the direct transaction",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"totalAmount": {
"description": "The amount of the direct transaction, inclusive of tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "When negative, the push item will be converted to a DirectCost and will be pushed accordingly."
}
]
}
}
GET
Get direct income attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentIdhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments/:attachmentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get direct income
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId
QUERY PARAMS
directIncomeId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeIdhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get direct incomes
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page='http GET '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List direct income attachments
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachmentshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachmentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachmentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/directIncomes/:directIncomeId/attachments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get balance sheet
{{baseUrl}}/companies/:companyId/data/financials/balanceSheet
QUERY PARAMS
periodLength
periodsToCompare
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/financials/balanceSheet" {:query-params {:periodLength ""
:periodsToCompare ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet',
params: {periodLength: '', periodsToCompare: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet',
qs: {periodLength: '', periodsToCompare: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet');
req.query({
periodLength: '',
periodsToCompare: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet',
params: {periodLength: '', periodsToCompare: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/financials/balanceSheet');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'periodLength' => '',
'periodsToCompare' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/financials/balanceSheet');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'periodLength' => '',
'periodsToCompare' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/financials/balanceSheet"
querystring = {"periodLength":"","periodsToCompare":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/financials/balanceSheet"
queryString <- list(
periodLength = "",
periodsToCompare = ""
)
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/financials/balanceSheet') do |req|
req.params['periodLength'] = ''
req.params['periodsToCompare'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/financials/balanceSheet";
let querystring = [
("periodLength", ""),
("periodsToCompare", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare='http GET '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/financials/balanceSheet?periodLength=&periodsToCompare=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get cash flow statement
{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement
QUERY PARAMS
periodLength
periodsToCompare
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement" {:query-params {:periodLength ""
:periodsToCompare ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement',
params: {periodLength: '', periodsToCompare: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement',
qs: {periodLength: '', periodsToCompare: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement');
req.query({
periodLength: '',
periodsToCompare: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement',
params: {periodLength: '', periodsToCompare: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'periodLength' => '',
'periodsToCompare' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'periodLength' => '',
'periodsToCompare' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement"
querystring = {"periodLength":"","periodsToCompare":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement"
queryString <- list(
periodLength = "",
periodsToCompare = ""
)
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/financials/cashFlowStatement') do |req|
req.params['periodLength'] = ''
req.params['periodsToCompare'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement";
let querystring = [
("periodLength", ""),
("periodsToCompare", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare='http GET '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/financials/cashFlowStatement?periodLength=&periodsToCompare=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get profit and loss
{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss
QUERY PARAMS
periodLength
periodsToCompare
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss" {:query-params {:periodLength ""
:periodsToCompare ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss',
params: {periodLength: '', periodsToCompare: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss',
qs: {periodLength: '', periodsToCompare: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss');
req.query({
periodLength: '',
periodsToCompare: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss',
params: {periodLength: '', periodsToCompare: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'periodLength' => '',
'periodsToCompare' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'periodLength' => '',
'periodsToCompare' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss"
querystring = {"periodLength":"","periodsToCompare":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss"
queryString <- list(
periodLength = "",
periodsToCompare = ""
)
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/financials/profitAndLoss') do |req|
req.params['periodLength'] = ''
req.params['periodsToCompare'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss";
let querystring = [
("periodLength", ""),
("periodsToCompare", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare='http GET '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/financials/profitAndLoss?periodLength=&periodsToCompare=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create invoice
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/invoices HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/invoices',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/invoices", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/invoices') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoicesimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
DELETE
Delete invoice
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId
QUERY PARAMS
invoiceId
companyId
connectionId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}DELETE /baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceIdhttp DELETE {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceIdwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Download invoice attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download
QUERY PARAMS
invoiceId
attachmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/downloadhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/downloadwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/downloadimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId/download")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create-update invoice model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/invoices HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/invoices',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/invoices")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/invoices') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoiceshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoiceswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoicesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/invoices")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"currency": {
"description": "Currency of the invoice",
"displayName": "Currency",
"options": [
{
"displayName": "AED",
"required": false,
"type": "String",
"value": "AED"
},
{
"displayName": "AMD",
"required": false,
"type": "String",
"value": "AMD"
},
{
"displayName": "AOA",
"required": false,
"type": "String",
"value": "AOA"
},
{
"displayName": "ARS",
"required": false,
"type": "String",
"value": "ARS"
},
{
"displayName": "AUD",
"required": false,
"type": "String",
"value": "AUD"
},
{
"displayName": "AWG",
"required": false,
"type": "String",
"value": "AWG"
},
{
"displayName": "AZN",
"required": false,
"type": "String",
"value": "AZN"
},
{
"displayName": "BBD",
"required": false,
"type": "String",
"value": "BBD"
},
{
"displayName": "BDT",
"required": false,
"type": "String",
"value": "BDT"
},
{
"displayName": "BGN",
"required": false,
"type": "String",
"value": "BGN"
},
{
"displayName": "BRL",
"required": false,
"type": "String",
"value": "BRL"
},
{
"displayName": "BWP",
"required": false,
"type": "String",
"value": "BWP"
},
{
"displayName": "CAD",
"required": false,
"type": "String",
"value": "CAD"
},
{
"displayName": "CHF",
"required": false,
"type": "String",
"value": "CHF"
},
{
"displayName": "CLP",
"required": false,
"type": "String",
"value": "CLP"
},
{
"displayName": "CNY",
"required": false,
"type": "String",
"value": "CNY"
},
{
"displayName": "COP",
"required": false,
"type": "String",
"value": "COP"
},
{
"displayName": "CRC",
"required": false,
"type": "String",
"value": "CRC"
},
{
"displayName": "CUC",
"required": false,
"type": "String",
"value": "CUC"
},
{
"displayName": "CUP",
"required": false,
"type": "String",
"value": "CUP"
},
{
"displayName": "CZK",
"required": false,
"type": "String",
"value": "CZK"
},
{
"displayName": "DKK",
"required": false,
"type": "String",
"value": "DKK"
},
{
"displayName": "DOP",
"required": false,
"type": "String",
"value": "DOP"
},
{
"displayName": "EGP",
"required": false,
"type": "String",
"value": "EGP"
},
{
"displayName": "EUR",
"required": false,
"type": "String",
"value": "EUR"
},
{
"displayName": "FJD",
"required": false,
"type": "String",
"value": "FJD"
},
{
"displayName": "GBP",
"required": false,
"type": "String",
"value": "GBP"
},
{
"displayName": "GEL",
"required": false,
"type": "String",
"value": "GEL"
},
{
"displayName": "GHS",
"required": false,
"type": "String",
"value": "GHS"
},
{
"displayName": "GTQ",
"required": false,
"type": "String",
"value": "GTQ"
},
{
"displayName": "GYD",
"required": false,
"type": "String",
"value": "GYD"
},
{
"displayName": "HKD",
"required": false,
"type": "String",
"value": "HKD"
},
{
"displayName": "HNL",
"required": false,
"type": "String",
"value": "HNL"
},
{
"displayName": "HRK",
"required": false,
"type": "String",
"value": "HRK"
},
{
"displayName": "HUF",
"required": false,
"type": "String",
"value": "HUF"
},
{
"displayName": "IDR",
"required": false,
"type": "String",
"value": "IDR"
},
{
"displayName": "ILS",
"required": false,
"type": "String",
"value": "ILS"
},
{
"displayName": "INR",
"required": false,
"type": "String",
"value": "INR"
},
{
"displayName": "ISK",
"required": false,
"type": "String",
"value": "ISK"
},
{
"displayName": "JMD",
"required": false,
"type": "String",
"value": "JMD"
},
{
"displayName": "JPY",
"required": false,
"type": "String",
"value": "JPY"
},
{
"displayName": "KES",
"required": false,
"type": "String",
"value": "KES"
},
{
"displayName": "KRW",
"required": false,
"type": "String",
"value": "KRW"
},
{
"displayName": "KWD",
"required": false,
"type": "String",
"value": "KWD"
},
{
"displayName": "KYD",
"required": false,
"type": "String",
"value": "KYD"
},
{
"displayName": "KZT",
"required": false,
"type": "String",
"value": "KZT"
},
{
"displayName": "LAK",
"required": false,
"type": "String",
"value": "LAK"
},
{
"displayName": "LBP",
"required": false,
"type": "String",
"value": "LBP"
},
{
"displayName": "LKR",
"required": false,
"type": "String",
"value": "LKR"
},
{
"displayName": "LTL",
"required": false,
"type": "String",
"value": "LTL"
},
{
"displayName": "LVL",
"required": false,
"type": "String",
"value": "LVL"
},
{
"displayName": "MAD",
"required": false,
"type": "String",
"value": "MAD"
},
{
"displayName": "MDL",
"required": false,
"type": "String",
"value": "MDL"
},
{
"displayName": "MGA",
"required": false,
"type": "String",
"value": "MGA"
},
{
"displayName": "MUR",
"required": false,
"type": "String",
"value": "MUR"
},
{
"displayName": "MVR",
"required": false,
"type": "String",
"value": "MVR"
},
{
"displayName": "MWK",
"required": false,
"type": "String",
"value": "MWK"
},
{
"displayName": "MXN",
"required": false,
"type": "String",
"value": "MXN"
},
{
"displayName": "MYR",
"required": false,
"type": "String",
"value": "MYR"
},
{
"displayName": "MZN",
"required": false,
"type": "String",
"value": "MZN"
},
{
"displayName": "NAD",
"required": false,
"type": "String",
"value": "NAD"
},
{
"displayName": "NGN",
"required": false,
"type": "String",
"value": "NGN"
},
{
"displayName": "NOK",
"required": false,
"type": "String",
"value": "NOK"
},
{
"displayName": "NPR",
"required": false,
"type": "String",
"value": "NPR"
},
{
"displayName": "NZD",
"required": false,
"type": "String",
"value": "NZD"
},
{
"displayName": "OMR",
"required": false,
"type": "String",
"value": "OMR"
},
{
"displayName": "PEN",
"required": false,
"type": "String",
"value": "PEN"
},
{
"displayName": "PHP",
"required": false,
"type": "String",
"value": "PHP"
},
{
"displayName": "PKR",
"required": false,
"type": "String",
"value": "PKR"
},
{
"displayName": "PLN",
"required": false,
"type": "String",
"value": "PLN"
},
{
"displayName": "QAR",
"required": false,
"type": "String",
"value": "QAR"
},
{
"displayName": "RON",
"required": false,
"type": "String",
"value": "RON"
},
{
"displayName": "RSD",
"required": false,
"type": "String",
"value": "RSD"
},
{
"displayName": "RUB",
"required": false,
"type": "String",
"value": "RUB"
},
{
"displayName": "RWF",
"required": false,
"type": "String",
"value": "RWF"
},
{
"displayName": "SAR",
"required": false,
"type": "String",
"value": "SAR"
},
{
"displayName": "SCR",
"required": false,
"type": "String",
"value": "SCR"
},
{
"displayName": "SEK",
"required": false,
"type": "String",
"value": "SEK"
},
{
"displayName": "SGD",
"required": false,
"type": "String",
"value": "SGD"
},
{
"displayName": "THB",
"required": false,
"type": "String",
"value": "THB"
},
{
"displayName": "TND",
"required": false,
"type": "String",
"value": "TND"
},
{
"displayName": "TRY",
"required": false,
"type": "String",
"value": "TRY"
},
{
"displayName": "TTD",
"required": false,
"type": "String",
"value": "TTD"
},
{
"displayName": "TWD",
"required": false,
"type": "String",
"value": "TWD"
},
{
"displayName": "TZS",
"required": false,
"type": "String",
"value": "TZS"
},
{
"displayName": "UAH",
"required": false,
"type": "String",
"value": "UAH"
},
{
"displayName": "UGX",
"required": false,
"type": "String",
"value": "UGX"
},
{
"displayName": "USD",
"required": false,
"type": "String",
"value": "USD"
},
{
"displayName": "UYU",
"required": false,
"type": "String",
"value": "UYU"
},
{
"displayName": "VEF",
"required": false,
"type": "String",
"value": "VEF"
},
{
"displayName": "VND",
"required": false,
"type": "String",
"value": "VND"
},
{
"displayName": "VUV",
"required": false,
"type": "String",
"value": "VUV"
},
{
"displayName": "XAF",
"required": false,
"type": "String",
"value": "XAF"
},
{
"displayName": "XCD",
"required": false,
"type": "String",
"value": "XCD"
},
{
"displayName": "XOF",
"required": false,
"type": "String",
"value": "XOF"
},
{
"displayName": "ZAR",
"required": false,
"type": "String",
"value": "ZAR"
},
{
"displayName": "ZMK",
"required": false,
"type": "String",
"value": "ZMK"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not specified, defaults to the company's native currency",
"field": "Currency"
}
],
"warnings": []
}
},
"customerRef": {
"description": "Reference to the customer the invoice has been sent to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"dueDate": {
"description": "The date the invoice is due to be paid by",
"displayName": "Due Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "If not specified, payment terms will default to 0 days (due on receipt)",
"field": "DueDate"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The issuing date of the invoice",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the invoice",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "The FreeAgent income category",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": false,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"status": {
"description": "The current state of the invoice",
"displayName": "Invoice Status",
"options": [
{
"displayName": "Draft",
"required": false,
"type": "String",
"value": "Draft"
},
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"currency": {
"description": "Currency of the invoice",
"displayName": "Currency",
"required": false,
"type": "String"
},
"customerRef": {
"description": "Reference to the customer the invoice has been sent to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be valid Customer Id",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": false,
"type": "Number"
},
"dueDate": {
"description": "The date the invoice is due to be paid by",
"displayName": "Due Date",
"required": false,
"type": "DateTime"
},
"invoiceNumber": {
"description": "User friendly reference identifier for the invoice",
"displayName": "Invoice Number",
"required": false,
"type": "String"
},
"issueDate": {
"description": "The issuing date of the invoice",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the invoice",
"displayName": "Line Items",
"properties": {
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"required": false,
"type": "Object"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": false,
"type": "Array"
},
"note": {
"description": "Note about the invoice",
"displayName": "Note",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the invoice",
"displayName": "Invoice Status",
"options": [
{
"displayName": "Draft",
"required": false,
"type": "Array",
"value": "Draft"
},
{
"displayName": "Open",
"required": false,
"type": "Array",
"value": "Submitted"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"additionalTaxAmount": {
"description": "Tax added to the total tax of the lines",
"displayName": "Additional Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "AdditionalTaxAmount"
}
],
"warnings": []
}
},
"amountDue": {
"description": "The amount outstanding on the invoice",
"displayName": "Amount Due",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "AmountDue"
},
{
"details": "Must be at least zero and no more than that the total amount.",
"field": "AmountDue"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the invoice",
"displayName": "Currency",
"options": [
{
"displayName": "Australian Dollar",
"required": false,
"type": "String",
"value": "AUD"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Currency"
}
],
"warnings": []
}
},
"customerRef": {
"description": "Reference to the customer the invoice has been sent to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef"
}
],
"warnings": []
}
},
"dueDate": {
"description": "The date the invoice is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "DueDate"
}
],
"warnings": []
}
},
"invoiceNumber": {
"description": "User friendly reference identifier for the invoice",
"displayName": "Invoice Number",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be greater than 8 characters long.",
"field": "InvoiceNumber"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The issuing date of the invoice",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must not be before the due date.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the invoice",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.AccountRef"
}
],
"warnings": []
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be greater than 225 characters long.",
"field": "LineItems.Description"
}
],
"warnings": []
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "ItemRef.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "LineItems.SubTotal"
}
]
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "LineItems.TaxAmount"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TaxRateRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TaxRateRef"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "LineItems.TotalAmount"
},
{
"details": "Must be provided.",
"field": "LineItems.TotalAmount"
}
],
"warnings": []
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "LineItems.UnitAmount"
},
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"status": {
"description": "The current state of the invoice",
"displayName": "Invoice Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String"
},
"subTotal": {
"description": "The total amount of the invoice excluding any taxes",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "SubTotal"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The amount of the invoice, inclusive of tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Must be greater than zero.",
"field": "TotalAmount"
}
]
}
},
"totalDiscount": {
"description": "The value, in the given invoice currency, of any discounts applied",
"displayName": "Discount Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "TotalDiscount"
}
],
"warnings": []
}
},
"totalTaxAmount": {
"description": "The total amount of tax on the invoice",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "TotalTaxAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"currency": {
"description": "Currency of the invoice",
"displayName": "Currency",
"required": false,
"type": "String"
},
"customerRef": {
"description": "Reference to the customer the invoice has been sent to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"dueDate": {
"description": "The date the invoice is due to be paid by",
"displayName": "Due Date",
"required": false,
"type": "DateTime"
},
"issueDate": {
"description": "The issuing date of the invoice",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the invoice",
"displayName": "Line Items",
"properties": {
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be provided for 'Discount' type items",
"field": "LineItems.Quantity"
}
]
}
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if and only if item does not have type 'Discount'",
"field": "LineItems.SubTotal"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": false,
"type": "Number"
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if item does not have type 'Discount'",
"field": "LineItems.TaxRateRef"
}
]
}
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "A single location tracking category must be present on all LineItems. Optionally, a single classification tracking category may be present on all LineItems. Also optionally, a single department tracking category may be present on all LineItems.",
"field": "TrackingCategoryRefs.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be provided for 'Discount' type items",
"field": "LineItems.UnitAmount"
}
]
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the invoice",
"displayName": "Note",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the invoice",
"displayName": "Invoice Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"currency": {
"description": "Currency of the invoice",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the default currency of the customer",
"field": "Currency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code that matches the currency of the customer",
"field": "Currency"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the invoice and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.",
"field": "CurrencyRate"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"customerRef": {
"description": "Reference to the customer the invoice has been sent to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing customer.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"dueDate": {
"description": "The date the invoice is due to be paid by",
"displayName": "Due Date",
"required": false,
"type": "DateTime"
},
"invoiceNumber": {
"description": "User friendly reference identifier for the invoice",
"displayName": "Invoice Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 11 characters.",
"field": "InvoiceNumber"
}
]
}
},
"issueDate": {
"description": "The issuing date of the invoice",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the invoice",
"displayName": "Line Items",
"properties": {
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"discountAmount": {
"description": "The value, in the given invoice currency, of any discounts applied",
"displayName": "Discount Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Can only be set if the line items itemRef refers to an item of type discount",
"field": "LineItems.DiscountAmount"
}
]
}
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Can only be set if the line items itemRef refers to an item of type discount",
"field": "LineItems.DiscountPercentage"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.ItemRef"
}
]
}
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "For US versions of QuickBooks Desktop, this must be a Tax Code",
"field": "TaxRateRef.Id"
},
{
"details": "For US versions of QuickBooks Desktop, this can only be set when Sales Tax is enabled; must be either 'Tax' or 'Non'",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tracking category.",
"field": "TrackingCategoryRefs.Id"
}
]
}
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the invoice",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4000 characters.",
"field": "Note"
}
]
}
},
"status": {
"description": "The current state of the invoice",
"displayName": "Invoice Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String"
},
"subTotal": {
"description": "The total amount of the invoice excluding any taxes",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of sub totals in the line items.",
"field": "SubTotal"
}
]
}
},
"totalAmount": {
"description": "The amount of the invoice, inclusive of tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of total amounts in the line items.",
"field": "TotalAmount"
}
]
}
},
"totalTaxAmount": {
"description": "The total amount of tax on the invoice",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of tax amounts in the line items.",
"field": "TotalTaxAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"currency": {
"description": "Currency of the invoice",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the invoice and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if Currency is not the base currency.",
"field": "CurrencyRate"
}
],
"warnings": [
{
"details": "Must not be less than 0.",
"field": "CurrencyRate"
}
]
}
},
"customerRef": {
"description": "Reference to the customer the invoice has been sent to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing customer.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "If provided must be a number between 0 and 100.",
"field": "DiscountPercentage"
}
]
}
},
"dueDate": {
"description": "The date the invoice is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "DueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the invoice",
"displayName": "Line Items",
"properties": {
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Description"
}
],
"warnings": [
{
"details": "Maximum character length should not be longer than 4000.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "When set to SHIPPING_ITEM_ID, the item will represent shipping.",
"field": "ItemRef.Id"
},
{
"details": "If not provided, will use the default item set for the company.",
"field": "ItemRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": false,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If an organisation has Automated Sales Tax enabled for US locales, then 'TAX' (Automated Sales Tax), 'NON' (no tax) or a custom tax rate can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used.",
"field": "TaxRateRef.Id"
},
{
"details": "Must be provided.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax code.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "A tracking category of type CLASS can only be provided if ClassTrackingPerTxnLine is enabled for the QBO company.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "Only one tracking category of type CLASS can be provided per item.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "A tracking category of type DEPARTMENT should be declared at the top level item (first line item).",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "A tracking category of type DEPARTMENT can only be provided if TrackDepartments is enabled for the QBO company.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "Only one tracking category of type DEPARTMENT can be provided per invoice.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "Must match the ID of an existing tracking category and be of type DEPARTMENT or CLASS.",
"field": "TrackingCategoryRefs.Id"
}
]
}
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Note about the invoice",
"displayName": "Note",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the invoice",
"displayName": "Invoice Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "QuickBooks Online only supports \"Submitted\" as a status for new invoices.",
"field": "Status"
}
],
"warnings": []
}
},
"totalDiscount": {
"description": "The value, in the given invoice currency, of any discounts applied",
"displayName": "Discount Amount",
"required": false,
"type": "Number"
},
"totalTaxAmount": {
"description": "The total amount of tax on the invoice",
"displayName": "Tax Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Tax will not be overridden if TotalTaxAmount is 0.",
"field": "TotalTaxAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Automated Sales Tax is disabled for this company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"currency": {
"description": "The currency in which the invoice is issued in.",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "This must match the customer's default currency.",
"field": "currency"
}
]
}
},
"customerRef": {
"description": "Customer to be invoiced.",
"displayName": "Customer",
"properties": {
"id": {
"description": "Identifier of the customer.",
"displayName": "Customer Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing customer and have a max length of 8 characters.",
"field": "customerRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"invoiceNumber": {
"description": "The reference number for this invoice",
"displayName": "Invoice Number",
"required": true,
"type": "String"
},
"lineItems": {
"description": "Line items of the invoice.",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Identifier for the account.",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "Identifier of the account.",
"displayName": "Account Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account. The account must also not be a bank account",
"field": "accountRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"taxRateRef": {
"description": "Tax rate reference of a invoice line item.",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "ID of the tax rate.",
"displayName": "Tax Rate Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tax rate.",
"field": "taxRateRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "Tracking categories for the line item",
"displayName": "Tracking Categories",
"properties": {
"id": {
"description": "Prefixed identifier for tracking category e.g. project_{x}, department_{x}",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Projects assigned with project_{x} must exist in Sage50",
"field": "trackingCategoryRefs.id"
},
{
"details": "Departments assigned with department_{x} must exist in Sage50",
"field": "trackingCategoryRefs.id"
}
]
}
}
},
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "To be used for any additional information associated with the invoice.",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Maximum 60 characters",
"field": "note"
}
]
}
},
"status": {
"description": "The status of the invoice",
"displayName": "Status",
"options": [
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If this is not set, it will default to 'Submitted'.",
"field": "status"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"currency": {
"description": "Currency of the invoice",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If supplied, must match the currency of the customer.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the invoice and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"customerRef": {
"description": "Reference to the customer the invoice has been sent to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing customer.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"issueDate": {
"description": "The issuing date of the invoice",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the invoice",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Description"
}
],
"warnings": [
{
"details": "Should not be longer than 2000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TaxAmount"
}
],
"warnings": []
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax rate.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If supplied, must match the total of the line including tax.",
"field": "LineItems.TotalAmount"
}
],
"warnings": []
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"note": {
"description": "Note about the invoice",
"displayName": "Note",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the invoice",
"displayName": "Invoice Status",
"options": [
{
"displayName": "Draft",
"required": false,
"type": "String",
"value": "Draft"
},
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"customerRef": {
"description": "Reference to the customer the invoice has been sent to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"dueDate": {
"description": "The date the invoice is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime"
},
"issueDate": {
"description": "The issuing date of the invoice",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the invoice",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be set when creating a sales invoice.",
"field": "AccountRef.Id"
},
{
"details": "Must be set when creating an invoice.",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be set for all line items when creating a sales invoice otherwise this field must be empty.",
"field": "ItemRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be greater than 0 for a sales invoice.",
"field": "LineItems.Quantity"
},
{
"details": "Must be set to 1 for an invoice.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be set for a sales invoice.",
"field": "TaxRateRef.Id"
},
{
"details": "Must be set for an invoice.",
"field": "TaxRateRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Is optional when creating an invoice.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "When creating a sales invoice WAREHOUSE must be supplied.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "When creating a sales invoice the ITEM category id must match the ItemRef.Id.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "Available tracking categories DEPARTMENT, LOCATION, CLASS, ITEM, PROJECT, WAREHOUSE, TASK, CONTRACT, CUSTOMER, SUPPLIER.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "Must take the form 'TrackingCategoryName-XYZ' e.g. to track an item with id 123 the id must be ITEM-123",
"field": "TrackingCategoryRefs.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be greater than zero.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must contain at least one line item.",
"field": "LineItems"
}
],
"warnings": []
}
},
"note": {
"description": "Note about the invoice",
"displayName": "Note",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the invoice",
"displayName": "Invoice Status",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be either Draftor Submitted.",
"field": "Status"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"additionalTaxAmount": {
"description": "Tax added to the total tax of the lines",
"displayName": "Additional Tax Amount",
"required": true,
"type": "Number"
},
"additionalTaxPercentage": {
"description": "The percentage of the additional tax to the TotalAmount",
"displayName": "Additional Tax Percentage",
"required": true,
"type": "Number"
},
"amountDue": {
"description": "The amount outstanding on the invoice",
"displayName": "Amount Due",
"required": true,
"type": "Number"
},
"currency": {
"description": "Currency of the invoice",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the invoice and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"customerRef": {
"description": "Reference to the customer the invoice has been sent to",
"displayName": "Customer Reference",
"properties": {
"companyName": {
"description": "The name of the customer referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"dueDate": {
"description": "The date the invoice is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime"
},
"invoiceNumber": {
"description": "User friendly reference identifier for the invoice",
"displayName": "Invoice Number",
"required": true,
"type": "String"
},
"issueDate": {
"description": "The issuing date of the invoice",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the invoice",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String"
},
"discountAmount": {
"description": "The value, in the given invoice currency, of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"isDirectIncome": {
"description": "True if this invoice is also mapped as a direct income",
"displayName": "Is Direct Income",
"required": true,
"type": "Boolean"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the item referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "The amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"tracking": {
"description": "A collection of items this line item is being tracked against",
"displayName": "Accounts Receivable Tracking",
"properties": {
"categoryRefs": {
"description": "A collection of categories this line item is being tracked against",
"displayName": "Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"customerRef": {
"description": "Reference to the customer this line item is being tracked against",
"displayName": "Customer Reference",
"properties": {
"companyName": {
"description": "The name of the customer referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"isBilledTo": {
"description": "The type of item this line item is billed to.",
"displayName": "Is Billed To",
"required": true,
"type": "String"
},
"isRebilledTo": {
"description": "The type of item this line item is billed to",
"displayName": "Is Rebilled To",
"required": true,
"type": "String"
},
"projectRef": {
"description": "Reference to the project this line item is being tracked against",
"displayName": "Project Reference",
"properties": {
"id": {
"description": "The reference identifier for the Project",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the Project referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"note": {
"description": "Note about the invoice",
"displayName": "Note",
"required": true,
"type": "String"
},
"paidOnDate": {
"description": "The date that the invoice was fully paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime"
},
"paymentAllocations": {
"description": "A collection of payments allocated to the invoice",
"displayName": "Payment Allocations",
"properties": {
"allocation": {
"description": "The allocation information",
"displayName": "Allocation",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"currency": {
"description": "The currency of the transaction",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the transaction",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The total amount that has been allocated",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"payment": {
"description": "The payment to be allocated",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the account associated with the allocated payment",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the payment",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the allocated payment and the currency of the base company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the allocated payment",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"note": {
"description": "Any additional text based information associated with the allocated payment",
"displayName": "Note",
"required": true,
"type": "String"
},
"paidOnDate": {
"description": "The date the payment was paid",
"displayName": "Paid On Date",
"required": true,
"type": "DateTime"
},
"reference": {
"description": "Reference associated with the allocated payment",
"displayName": "Reference",
"required": true,
"type": "String"
},
"totalAmount": {
"description": "The total amount that has been paid",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array"
},
"salesOrderRefs": {
"description": "References to related Sales Orders",
"displayName": "Sales Order References",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"status": {
"description": "The current state of the invoice",
"displayName": "Invoice Status",
"required": true,
"type": "String"
},
"subTotal": {
"description": "The total amount of the invoice excluding any taxes",
"displayName": "Sub Total Amount",
"required": true,
"type": "Number"
},
"totalAmount": {
"description": "The amount of the invoice, inclusive of tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"totalDiscount": {
"description": "The value, in the given invoice currency, of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"totalTaxAmount": {
"description": "The total amount of tax on the invoice",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"withholdingTax": {
"description": "A collection of tax deductions",
"displayName": "Withholding Tax",
"properties": {
"amount": {
"description": "Deduction amount",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"name": {
"description": "Name of the deduction",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"currency": {
"description": "Currency of the invoice",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the invoice and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If no rate is specified, the Xero day rate will be applied.",
"field": "CurrencyRate",
"ref": "https://central.xero.com/s/#CurrencySettings$Rates"
}
],
"warnings": []
}
},
"customerRef": {
"description": "Reference to the customer the invoice has been sent to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "CustomerRef.Id"
},
{
"details": "Must match the ID of an existing customer.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef"
}
],
"warnings": []
}
},
"dueDate": {
"description": "The date the invoice is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "DueDate"
}
],
"warnings": []
}
},
"invoiceNumber": {
"description": "User friendly reference identifier for the invoice",
"displayName": "Invoice Number",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not exceed 255 charaters long.",
"field": "InvoiceNumber"
}
],
"warnings": []
}
},
"issueDate": {
"description": "The issuing date of the invoice",
"displayName": "Issue Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "A collection of lines that detail items related to the invoice",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.AccountRef"
}
],
"warnings": []
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 4000 characters long.",
"field": "LineItems.Description"
}
],
"warnings": []
}
},
"discountPercentage": {
"description": "The percentage rate of any discount that has been applied",
"displayName": "Discount Percentage",
"required": false,
"type": "Number"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "ItemRef.Id"
},
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.Quantity"
}
],
"warnings": []
}
},
"taxAmount": {
"description": "The amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.TaxAmount"
}
],
"warnings": []
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "TaxRateRef.Id"
},
{
"details": "Must match the ID of an existing tax rate.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this item is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be a parent tracking category.",
"field": "TrackingCategoryRefs.Id"
},
{
"details": "Must be provided.",
"field": "TrackingCategoryRefs.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Tracking categories must not have the same parent tracking category.",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "Maximum of 2 Tracking Categories.",
"field": "LineItems.TrackingCategoryRefs"
}
],
"warnings": []
}
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems.UnitAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "LineItems"
}
],
"warnings": []
}
},
"status": {
"description": "The current state of the invoice",
"displayName": "Invoice Status",
"options": [
{
"displayName": "Draft",
"required": false,
"type": "String",
"value": "Draft"
},
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Status"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An invoice is an itemised record of goods sold or services rendered to a customer",
"displayName": "Invoice",
"properties": {
"currency": {
"description": "Currency of the invoice",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the customer's currency",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the invoice and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater than or equal to 0",
"field": "CurrencyRate"
}
]
}
},
"customerRef": {
"description": "Reference to the customer the invoice has been sent to",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"dueDate": {
"description": "The date the invoice is due to be paid by",
"displayName": "Due Date",
"required": true,
"type": "DateTime"
},
"invoiceNumber": {
"description": "User friendly reference identifier for the invoice",
"displayName": "Invoice Number",
"required": false,
"type": "String"
},
"issueDate": {
"description": "The issuing date of the invoice",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "A collection of lines that detail items related to the invoice",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be of type 'Income' or 'Other Income'",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name of the goods or services purchased",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if ItemRef is not set",
"field": "LineItems.Description"
}
]
}
},
"discountAmount": {
"description": "The value, in the given invoice currency, of any discounts applied",
"displayName": "Discount Amount",
"required": false,
"type": "Number"
},
"itemRef": {
"description": "Reference to the product or service type, or inventory item, the line item is linked to",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if Description is not set",
"field": "LineItems.ItemRef"
}
]
}
},
"quantity": {
"description": "The number of units of goods or services purchased",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater than or equal to 0",
"field": "LineItems.Quantity"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"unitAmount": {
"description": "The price of each unit of goods or services",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "The sum of subtotals over all the line items must be greater than or equal to 0",
"field": "LineItems"
},
{
"details": "Must not be empty",
"field": "LineItems"
}
]
}
},
"note": {
"description": "Note about the invoice",
"displayName": "Note",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the invoice",
"displayName": "Invoice Status",
"options": [
{
"displayName": "Draft",
"required": false,
"type": "String",
"value": "Draft"
},
{
"displayName": "Submitted",
"required": false,
"type": "String",
"value": "Submitted"
},
{
"displayName": "Void",
"required": false,
"type": "String",
"value": "Void"
}
],
"required": true,
"type": "String"
},
"totalDiscount": {
"description": "The value, in the given invoice currency, of any discounts applied",
"displayName": "Discount Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "If DiscountAmount is set for at least one Line Item, TotalDiscount must be the sum of Discount Amounts over all line items. Otherwise invoice level discount will be applied",
"field": "TotalDiscount"
}
]
}
}
},
"required": true,
"type": "Object"
}
GET
Get invoice as PDF
{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf
QUERY PARAMS
invoiceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/invoices/:invoiceId/pdf HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/invoices/:invoiceId/pdf',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/invoices/:invoiceId/pdf")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/invoices/:invoiceId/pdf') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdfhttp GET {{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdfwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdfimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId/pdf")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get invoice attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId
QUERY PARAMS
invoiceId
attachmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentIdhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments/:attachmentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get invoice attachments
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments
QUERY PARAMS
invoiceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachmentshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachmentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachmentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/invoices/:invoiceId/attachments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get invoice
{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId
QUERY PARAMS
invoiceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/invoices/:invoiceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/invoices/:invoiceId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/invoices/:invoiceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/invoices/:invoiceId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/invoices/:invoiceIdhttp GET {{baseUrl}}/companies/:companyId/data/invoices/:invoiceIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/invoices/:invoiceIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/invoices/:invoiceId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List invoices
{{baseUrl}}/companies/:companyId/data/invoices
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/invoices?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/invoices" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/invoices?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/invoices?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/invoices?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/invoices?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/invoices?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/invoices?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/invoices?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/invoices?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/invoices?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/invoices?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/invoices',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/invoices?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/invoices?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/invoices?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/invoices?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/invoices',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/invoices');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/invoices',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/invoices?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/invoices?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/invoices?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/invoices?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/invoices?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/invoices');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/invoices');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/invoices?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/invoices?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/invoices?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/invoices"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/invoices"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/invoices?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/invoices') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/invoices";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/invoices?page='http GET '{{baseUrl}}/companies/:companyId/data/invoices?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/invoices?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/invoices?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Push invoice attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment
QUERY PARAMS
invoiceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment"
response = HTTP::Client.post url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment")
.post(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment")
.post(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment' -Method POST $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment' -Method POST import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment"
response = requests.post(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachmenthttp POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachmentwget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachmentimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId/attachment")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Update invoice
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId
QUERY PARAMS
invoiceId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"
payload = {}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId"
payload <- "{}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http PUT {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceIdimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/invoices/:invoiceId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create item
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/items HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/items',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/items", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/items') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/items \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/items \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/itemsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/items")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create item model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/items HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/items',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/items")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/items') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/itemshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/itemswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/itemsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/items")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An item includes details about a product or service that is provided to customers, or provided by suppliers",
"displayName": "Item",
"properties": {
"billItem": {
"description": "Item details specific to its usage with bills",
"displayName": "Bill Item Details",
"properties": {
"accountRef": {
"description": "Reference to the default nominal account the item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": false,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"description": {
"description": "The description of the item",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4096 characters.",
"field": "BillItem.Description"
}
]
}
},
"taxRateRef": {
"description": "Reference to the default tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 30 characters.",
"field": "TaxRateRef.Name"
}
]
}
}
},
"required": false,
"type": "Object"
},
"unitPrice": {
"description": "The default unit price for the item",
"displayName": "Unit Price",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Value should be zero or greater",
"field": "BillItem.UnitPrice"
}
]
}
}
},
"required": false,
"type": "Object"
},
"invoiceItem": {
"description": "Item details specific to its usage with invoices",
"displayName": "Invoice Item Details",
"properties": {
"accountRef": {
"description": "Reference to the default nominal account the item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "The description of the item",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4096 characters.",
"field": "InvoiceItem.Description"
}
]
}
},
"taxRateRef": {
"description": "Reference to the default tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 30 characters.",
"field": "TaxRateRef.Name"
}
]
}
}
},
"required": false,
"type": "Object"
},
"unitPrice": {
"description": "The default unit price for the item",
"displayName": "Unit Price",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Value should be zero or greater",
"field": "InvoiceItem.UnitPrice"
}
]
}
}
},
"required": true,
"type": "Object"
},
"itemStatus": {
"description": "The state of the item",
"displayName": "Item Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"name": {
"description": "The name for the item",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Sub-items are supported by introducing a colon in between parent and child i.e. Parent : Child",
"field": "Name"
},
{
"details": "Max length of 31 characters.",
"field": "Name"
}
]
}
},
"type": {
"description": "The type of the item",
"displayName": "Item Type",
"options": [
{
"displayName": "Non inventory type",
"required": false,
"type": "String",
"value": "NonInventory"
},
{
"displayName": "Service type",
"required": false,
"type": "String",
"value": "Service"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An item includes details about a product or service that is provided to customers, or provided by suppliers",
"displayName": "Item",
"properties": {
"billItem": {
"description": "Item details specific to its usage with bills",
"displayName": "Bill Item Details",
"properties": {
"accountRef": {
"description": "Reference to the default nominal account the item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "The description of the item",
"displayName": "Description",
"required": true,
"type": "String"
},
"taxRateRef": {
"description": "Reference to the default tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) or 'NON' (no tax) will not be accepted and a different tax rate must be used.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax code.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"unitPrice": {
"description": "The default unit price for the item",
"displayName": "Unit Price",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"code": {
"description": "A user friendly reference for the item",
"displayName": "Code",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Should not be longer than 21 characters.",
"field": "Code"
}
],
"warnings": []
}
},
"invoiceItem": {
"description": "Item details specific to its usage with invoices",
"displayName": "Invoice Item Details",
"properties": {
"accountRef": {
"description": "Reference to the default nominal account the item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "The description of the item",
"displayName": "Description",
"required": true,
"type": "String"
},
"taxRateRef": {
"description": "Reference to the default tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) or 'NON' (no tax) will not be accepted and a different tax rate must be used.",
"field": "TaxRateRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing tax code.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"unitPrice": {
"description": "The default unit price for the item",
"displayName": "Unit Price",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"isBillItem": {
"description": "State whether this item can be used with bills",
"displayName": "Is Bill Item?",
"required": true,
"type": "Boolean"
},
"isInvoiceItem": {
"description": "State whether this item can be used with invoices",
"displayName": "Is Invoice Item?",
"required": true,
"type": "Boolean"
},
"name": {
"description": "The name for the item",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Should not be longer than 21 characters.",
"field": "Name"
}
],
"warnings": [
{
"details": "Names must be unique across items.",
"field": "Name"
}
]
}
},
"type": {
"description": "The type of the item",
"displayName": "Item Type",
"options": [
{
"displayName": "Non Inventory",
"required": false,
"type": "String",
"value": "NonInventory"
},
{
"displayName": "Service",
"required": false,
"type": "String",
"value": "Service"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An item includes details about a product or service that is provided to customers, or provided by suppliers",
"displayName": "Item",
"properties": {
"billItem": {
"description": "Item details specific to its usage with bills",
"displayName": "Bill Item Details",
"properties": {
"accountRef": {
"description": "Reference to the default nominal account the item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "The description of the item",
"displayName": "Description",
"required": true,
"type": "String"
},
"taxRateRef": {
"description": "Reference to the default tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"unitPrice": {
"description": "The default unit price for the item",
"displayName": "Unit Price",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"code": {
"description": "A user friendly reference for the item",
"displayName": "Code",
"required": true,
"type": "String"
},
"invoiceItem": {
"description": "Item details specific to its usage with invoices",
"displayName": "Invoice Item Details",
"properties": {
"accountRef": {
"description": "Reference to the default nominal account the item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "The description of the item",
"displayName": "Description",
"required": true,
"type": "String"
},
"taxRateRef": {
"description": "Reference to the default tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"unitPrice": {
"description": "The default unit price for the item",
"displayName": "Unit Price",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"isBillItem": {
"description": "State whether this item can be used with bills",
"displayName": "Is Bill Item?",
"required": true,
"type": "Boolean"
},
"isInvoiceItem": {
"description": "State whether this item can be used with invoices",
"displayName": "Is Invoice Item?",
"required": true,
"type": "Boolean"
},
"itemStatus": {
"description": "The state of the item",
"displayName": "Item Status",
"required": true,
"type": "String"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"name": {
"description": "The name for the item",
"displayName": "Name",
"required": true,
"type": "String"
},
"type": {
"description": "The type of the item",
"displayName": "Item Type",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An item includes details about a product or service that is provided to customers, or provided by suppliers",
"displayName": "Item",
"properties": {
"billItem": {
"description": "Item details specific to its usage with bills",
"displayName": "Bill Item Details",
"properties": {
"accountRef": {
"description": "Reference to the default nominal account the item is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if Item is of type Inventory.",
"field": "AccountRef.Id"
},
{
"details": "Must be provided if AccountRef is not null.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if Item is of type Inventory.",
"field": "BillItem.AccountRef"
}
]
}
},
"description": {
"description": "The description of the item",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be longer than 4000 characters long.",
"field": "BillItem.Description"
}
]
}
},
"taxRateRef": {
"description": "Reference to the default tax rate code the line item is linked to",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided if TaxRateRef is not null.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided if Item is of type Inventory.",
"field": "BillItem"
},
{
"details": "Must not be provided if IsBillItem is false.",
"field": "BillItem"
},
{
"details": "Must be provided if IsBillItem is true.",
"field": "BillItem"
}
],
"warnings": []
}
},
"code": {
"description": "A user friendly reference for the item",
"displayName": "Code",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be longer than 30 characters long.",
"field": "Code"
},
{
"details": "Must be unique.",
"field": "Code"
},
{
"details": "Must be provided.",
"field": "Code"
}
]
}
},
"invoiceItem": {
"description": "Item details specific to its usage with invoices",
"displayName": "Invoice Item Details",
"properties": {
"accountRef": {
"description": "Reference to the default nominal account the item is linked to",
"displayName": "Nominal Account Reference",
"required": false,
"type": "Object"
},
"description": {
"description": "The description of the item",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be longer than 4000 characters long.",
"field": "InvoiceItem.Description"
}
]
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "Must not be provided if IsInvoiceItem is false.",
"field": "InvoiceItem"
},
{
"details": "Must be provided if IsInvoiceItem is true.",
"field": "InvoiceItem"
}
],
"warnings": []
}
},
"itemStatus": {
"description": "The state of the item",
"displayName": "Item Status",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Is ignored on push, and ItemStatus is always mapped as \"Unknown\"",
"field": "ItemStatus"
}
],
"warnings": []
}
},
"name": {
"description": "The name for the item",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be longer than 50 characters long.",
"field": "Name"
}
]
}
},
"type": {
"description": "The type of the item",
"displayName": "Item Type",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be 'Unknown' or 'Inventory', otherwise Item.Type will be defaulted to 'Unknown'.",
"field": "Type"
}
],
"warnings": [
{
"details": "Cannot be of type Inventory if no Inventory account exists in Xero.",
"field": "Type"
}
]
}
}
},
"required": true,
"type": "Object"
}
GET
Get item
{{baseUrl}}/companies/:companyId/data/items/:itemId
QUERY PARAMS
itemId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/items/:itemId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/items/:itemId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/items/:itemId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/items/:itemId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/items/:itemId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/items/:itemId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/items/:itemId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/items/:itemId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/items/:itemId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/items/:itemId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/items/:itemId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/items/:itemId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/items/:itemId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/items/:itemId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/items/:itemId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/items/:itemId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/items/:itemId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/items/:itemId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/items/:itemId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/items/:itemId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/items/:itemId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/items/:itemId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/items/:itemId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/items/:itemId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/items/:itemId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/items/:itemId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/items/:itemId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/items/:itemId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/items/:itemId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/items/:itemId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/items/:itemId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/items/:itemId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/items/:itemId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/items/:itemId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/items/:itemId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/items/:itemIdhttp GET {{baseUrl}}/companies/:companyId/data/items/:itemIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/items/:itemIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/items/:itemId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List items
{{baseUrl}}/companies/:companyId/data/items
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/items?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/items" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/items?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/items?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/items?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/items?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/items?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/items?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/items?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/items?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/items?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/items?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/items',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/items?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/items?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/items?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/items?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/items',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/items');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/items',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/items?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/items?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/items?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/items?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/items?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/items');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/items');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/items?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/items?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/items?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/items"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/items"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/items?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/items') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/items";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/items?page='http GET '{{baseUrl}}/companies/:companyId/data/items?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/items?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/items?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create journal entry
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/journalEntries HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/journalEntries',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/journalEntries", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/journalEntries') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntriesimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
DELETE
Delete journal entry
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}DELETE /baseUrl/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('DELETE', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryIdhttp DELETE {{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryIdwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalEntries/:journalEntryId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create journal entry model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/journalEntries HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/journalEntries',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/journalEntries")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/journalEntries') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntrieshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntrieswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntriesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalEntries")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"displayName": "JournalEntry",
"properties": {
"description": {
"description": "An optional top level description for the journal entry",
"displayName": "Description",
"required": false,
"type": "String"
},
"journalLines": {
"description": "A collection of detail lines that represent the transactions associated in this entry",
"displayName": "Journal Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Bank accounts are not allowed",
"field": "JournalLines.AccountRef"
}
]
}
},
"currency": {
"description": "The currency for the line",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only base currency is allowed",
"field": "JournalLines.Currency"
}
]
}
},
"netAmount": {
"description": "The amount for the journal line, excluding tax",
"displayName": "Net Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must contain 2 journal lines",
"field": "JournalLines"
}
]
}
},
"journalRef": {
"description": "Reference to the journal in which this journal entry was created",
"displayName": "Journal Reference",
"properties": {
"id": {
"description": "The reference identifier for the journal",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Only General type Journals are allowed",
"field": "JournalRef"
}
],
"warnings": []
}
},
"postedOn": {
"description": "The date the entry was posted in the originating system",
"displayName": "Posted On",
"required": true,
"type": "DateTime"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"displayName": "JournalEntry",
"properties": {
"description": {
"description": "An optional top level description for the journal entry",
"displayName": "Description",
"required": false,
"type": "String"
},
"journalLines": {
"description": "A collection of detail lines that represent the transactions associated in this entry",
"displayName": "Journal Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line is linked to",
"displayName": "Nominal Account Reference",
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Specified account must be in the same base currency as the subsidiary",
"field": "JournalLines.AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "The currency for the line",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be the base currency",
"field": "JournalLines.Currency"
}
],
"warnings": []
}
},
"description": {
"description": "The description for the journal line",
"displayName": "Description",
"required": false,
"type": "String"
},
"netAmount": {
"description": "The amount for the journal line, excluding tax",
"displayName": "Net Amount",
"required": true,
"type": "Number"
},
"tracking": {
"description": "Information this item is being tracked against",
"displayName": "Tracking",
"properties": {
"recordRefs": {
"description": "A collection of records this item is being tracked against",
"displayName": "Record References",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "trackingCategories",
"required": false,
"type": "String",
"value": "trackingCategories"
},
{
"displayName": "customers",
"required": false,
"type": "String",
"value": "customers"
},
{
"displayName": "suppliers",
"required": false,
"type": "String",
"value": "suppliers"
}
],
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "At most one trackingCategory RecordRef of each type (classification/department/location) may be provided, and only one entity (either customers/suppliers) RecordRef may be provided",
"field": "RecordRefs.DataType"
}
]
}
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array"
},
"postedOn": {
"description": "The date the entry was posted in the originating system",
"displayName": "Posted On",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Defaults to today's date if not specified",
"field": "PostedOn"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"displayName": "JournalEntry",
"properties": {
"journalLines": {
"description": "A collection of detail lines that represent the transactions associated in this entry",
"displayName": "Journal Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line is linked to",
"displayName": "Nominal Account Reference",
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "The currency of all accounts in the Journal Entry must use the base currency of the QuickBooks Desktop company",
"field": "JournalLines.AccountRef"
}
]
}
},
"currency": {
"description": "The currency for the line",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must match the base currency of the QuickBooks Desktop company",
"field": "JournalLines.Currency"
},
{
"details": "If not set, will default to the default currency of the QuickBooks Desktop company",
"field": "JournalLines.Currency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code that matches the currency of the QuickBooks Desktop company",
"field": "JournalLines.Currency"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "JournalLines.Currency"
}
]
}
},
"description": {
"description": "The description for the journal line",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4000 characters.",
"field": "JournalLines.Description"
}
]
}
},
"netAmount": {
"description": "The amount for the journal line, excluding tax",
"displayName": "Net Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "For debit lines, the net amount should be positive, for credit lines it should be negative",
"field": "JournalLines.NetAmount"
},
{
"details": "The sum of net amounts for all line items must be 0",
"field": "JournalLines.NetAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"postedOn": {
"description": "The date the entry was posted in the originating system",
"displayName": "Posted On",
"required": false,
"type": "DateTime"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"displayName": "JournalEntry",
"properties": {
"journalLines": {
"description": "A collection of detail lines that represent the transactions associated in this entry",
"displayName": "Journal Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the line",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company",
"field": "JournalLines.Currency"
},
{
"details": "When present, all JournalLine currencies should match",
"field": "JournalLines.Currency"
}
],
"warnings": []
}
},
"description": {
"description": "The description for the journal line",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be no longer than 4000 characters long",
"field": "JournalLines.Description"
}
],
"warnings": []
}
},
"netAmount": {
"description": "The amount for the journal line, excluding tax",
"displayName": "Net Amount",
"required": true,
"type": "Number"
},
"tracking": {
"description": "Information this item is being tracked against",
"displayName": "Tracking",
"properties": {
"recordRefs": {
"description": "A collection of records this item is being tracked against",
"displayName": "Record References",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be 'trackingCategories'",
"field": "RecordRefs.DataType"
}
]
}
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must begin with 'CLASS_' or 'DEPARTMENT_'",
"field": "RecordRefs.Id"
},
{
"details": "Must match the ID of an existing tracking category and be of type 'DEPARTMENT' or 'CLASS'.",
"field": "RecordRefs.Id"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not contain multiple 'CLASS_' records or 'DEPARTMENT_' records",
"field": "Tracking.RecordRefs"
}
]
}
}
},
"required": false,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "There must be at least two lines",
"field": "JournalLines"
}
],
"warnings": []
}
},
"postedOn": {
"description": "The date the entry was posted in the originating system",
"displayName": "Posted On",
"required": true,
"type": "DateTime"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "To push a JournalEntry to a French Company in QuickBooks Online, an active JournalCode with type 'Others' or 'Autres' must exist inside the Company"
}
]
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"displayName": "JournalEntry",
"properties": {
"journalLines": {
"description": "A collection of detail lines that represent the transactions associated in this entry",
"displayName": "Journal Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the line",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company",
"field": "JournalLines.Currency"
},
{
"details": "When present, all JournalLine currencies should match",
"field": "JournalLines.Currency"
}
],
"warnings": []
}
},
"description": {
"description": "The description for the journal line",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be no longer than 4000 characters long",
"field": "JournalLines.Description"
}
],
"warnings": []
}
},
"netAmount": {
"description": "The amount for the journal line, excluding tax",
"displayName": "Net Amount",
"required": true,
"type": "Number"
},
"tracking": {
"description": "Information this item is being tracked against",
"displayName": "Tracking",
"properties": {
"recordRefs": {
"description": "A collection of records this item is being tracked against",
"displayName": "Record References",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be 'trackingCategories'",
"field": "RecordRefs.DataType"
}
]
}
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must begin with 'CLASS_' or 'DEPARTMENT_'",
"field": "RecordRefs.Id"
},
{
"details": "Must match the ID of an existing tracking category and be of type 'DEPARTMENT' or 'CLASS'.",
"field": "RecordRefs.Id"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not contain multiple 'CLASS_' records or 'DEPARTMENT_' records",
"field": "Tracking.RecordRefs"
}
]
}
}
},
"required": false,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "There must be at least two lines",
"field": "JournalLines"
}
],
"warnings": []
}
},
"postedOn": {
"description": "The date the entry was posted in the originating system",
"displayName": "Posted On",
"required": true,
"type": "DateTime"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "To push a JournalEntry to a French Company in QuickBooks Online, an active JournalCode with type 'Others' or 'Autres' must exist inside the Company"
}
]
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"displayName": "JournalEntry",
"properties": {
"createdOn": {
"description": "Date on which the journal was created in Sage50.",
"displayName": "Created On",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "if empty then Sage 50 will auto generate a created on date",
"field": "createdOn"
}
],
"warnings": []
}
},
"dataType": {
"description": "Data type of the underlying record that created the journal entry.",
"displayName": "Data Type",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Is not supported and therefore will be ignored",
"field": "dataType"
}
]
}
},
"description": {
"description": "Optional description of the journal entry.",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Is not supported and therefore will be ignored",
"field": "description"
}
]
}
},
"id": {
"description": "The reference journal id",
"displayName": "Id",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Is not supported and therefore will be ignored",
"field": "id"
}
]
}
},
"journalLines": {
"description": "Journal line items of the journal entry.",
"displayName": "Journal Lines",
"properties": {
"accountRef": {
"description": "Links a journal entry to any associated accounts.",
"displayName": "accountRef",
"properties": {
"id": {
"description": "The ID of the Account the line is linked to.",
"displayName": "Id",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Cannot post journal entries against non-base currency nominal codes",
"field": "id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"currency": {
"description": "Currency for the journal line item.",
"displayName": "currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Journal entries can only be pushed in the base currency of the target company.",
"field": "journalLines.currency"
}
]
}
},
"description": {
"description": "Description of the journal line item.",
"displayName": "description",
"required": false,
"type": "String"
},
"netAmount": {
"description": "Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative.",
"displayName": "Net Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Cannot equal 0",
"field": "journalLines.netAmount"
}
]
}
}
},
"required": true,
"type": "Array"
},
"journalRef": {
"description": "Links journal entries to the relevant journal",
"displayName": "Journal Reference",
"required": false,
"type": "Object"
},
"modifiedDate": {
"description": "Date on which the record was last updated via pushes.",
"displayName": "Source Modified Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "Is not supported and therefore will be ignored",
"field": "modifiedDate"
}
]
}
},
"name": {
"description": "The reference journal name",
"displayName": "Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Is not supported and therefore will be ignored",
"field": "name"
}
]
}
},
"recordRef": {
"description": "Links a journal entry to the underlying record that created it.",
"displayName": "Record Reference",
"required": false,
"type": "Object"
},
"sourceModifiedDate": {
"description": "Date on which the record was last changed in Sage50.",
"displayName": "Source Modified Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "Is not supported and therefore will be ignored",
"field": "sourceModifiedDate"
}
]
}
},
"updatedOn": {
"description": "Date on which the journal was last updated in Sage50.",
"displayName": "Updated On",
"required": true,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "Is not supported and therefore will be ignored",
"field": "updatedOn"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"displayName": "JournalEntry",
"properties": {
"description": {
"description": "An optional top level description for the journal entry",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 512 characters",
"field": "Description"
}
]
}
},
"journalLines": {
"description": "A collection of detail lines that represent the transactions associated in this entry",
"displayName": "Journal Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the line",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "If provided, must match the base currency for the company",
"field": "JournalLines.Currency"
}
]
}
},
"description": {
"description": "The description for the journal line",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 512 characters",
"field": "JournalLines.Description"
}
]
}
},
"netAmount": {
"description": "The amount for the journal line, excluding tax",
"displayName": "Net Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be a 0 amount",
"field": "JournalLines.NetAmount"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "There must be at least two lines",
"field": "JournalLines"
}
]
}
},
"journalRef": {
"description": "Reference to the journal in which this journal entry was created",
"displayName": "Journal Reference",
"properties": {
"id": {
"description": "The reference identifier for the journal",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"postedOn": {
"description": "The date the entry was posted in the originating system",
"displayName": "Posted On",
"required": true,
"type": "DateTime"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"displayName": "JournalEntry",
"properties": {
"createdOn": {
"description": "The date the entry was created in the originating system",
"displayName": "Created On",
"required": true,
"type": "DateTime"
},
"description": {
"description": "An optional top level description for the journal entry",
"displayName": "Description",
"required": true,
"type": "String"
},
"journalLines": {
"description": "A collection of detail lines that represent the transactions associated in this entry",
"displayName": "Journal Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "The currency for the line",
"displayName": "Currency",
"required": true,
"type": "String"
},
"description": {
"description": "The description for the journal line",
"displayName": "Description",
"required": true,
"type": "String"
},
"netAmount": {
"description": "The amount for the journal line, excluding tax",
"displayName": "Net Amount",
"required": true,
"type": "Number"
},
"tracking": {
"description": "Information this item is being tracked against",
"displayName": "Tracking",
"properties": {
"recordRefs": {
"description": "A collection of records this item is being tracked against",
"displayName": "Record References",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Array"
},
"journalRef": {
"description": "Reference to the journal in which this journal entry was created",
"displayName": "Journal Reference",
"properties": {
"id": {
"description": "The reference identifier for the journal",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the journal",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"postedOn": {
"description": "The date the entry was posted in the originating system",
"displayName": "Posted On",
"required": true,
"type": "DateTime"
},
"recordRef": {
"description": "Reference to the record for which this journal entry was created",
"displayName": "Record Reference",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"updatedOn": {
"description": "The date in which the journal was last updated in the originating system",
"displayName": "Updated On",
"required": true,
"type": "DateTime"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"displayName": "JournalEntry",
"properties": {
"journalLines": {
"description": "A collection of detail lines that represent the transactions associated in this entry",
"displayName": "Journal Lines",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the line is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "JournalLines.AccountRef"
}
],
"warnings": []
}
},
"description": {
"description": "The description for the journal line",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 4000 characters long and must be the same for all lines.",
"field": "JournalLines.Description"
}
],
"warnings": []
}
},
"netAmount": {
"description": "The amount for the journal line, excluding tax",
"displayName": "Net Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "JournalLines.NetAmount"
}
],
"warnings": []
}
},
"tracking": {
"description": "Information this item is being tracked against",
"displayName": "Tracking",
"properties": {
"recordRefs": {
"description": "A collection of records this item is being tracked against",
"displayName": "Record References",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be a parent tracking category.",
"field": "RecordRefs.Id"
},
{
"details": "Must be provided.",
"field": "RecordRefs.Id"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Tracking categories must not have the same parent tracking category.",
"field": "Tracking.RecordRefs"
},
{
"details": "Maximum of 2 Tracking Categories.",
"field": "Tracking.RecordRefs"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Object"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "At least 2 must be provided.",
"field": "JournalLines"
}
],
"warnings": []
}
},
"postedOn": {
"description": "The date the entry was posted in the originating system",
"displayName": "Posted On",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "If no date is specified, it will default to today's date.",
"field": "PostedOn"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}
GET
Get journal entry
{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId
QUERY PARAMS
journalEntryId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/journalEntries/:journalEntryId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/journalEntries/:journalEntryId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/journalEntries/:journalEntryId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/journalEntries/:journalEntryId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryIdhttp GET {{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/journalEntries/:journalEntryId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List journal entries
{{baseUrl}}/companies/:companyId/data/journalEntries
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/journalEntries?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/journalEntries" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/journalEntries?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/journalEntries?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/journalEntries?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/journalEntries?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/journalEntries?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/journalEntries?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/journalEntries?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/journalEntries?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/journalEntries?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/journalEntries?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journalEntries',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/journalEntries?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/journalEntries?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/journalEntries?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/journalEntries?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journalEntries',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/journalEntries');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journalEntries',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/journalEntries?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/journalEntries?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/journalEntries?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/journalEntries?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/journalEntries?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/journalEntries');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/journalEntries');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/journalEntries?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/journalEntries?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/journalEntries?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/journalEntries"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/journalEntries"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/journalEntries?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/journalEntries') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/journalEntries";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/journalEntries?page='http GET '{{baseUrl}}/companies/:companyId/data/journalEntries?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/journalEntries?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/journalEntries?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create journal
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/journals HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/journals',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/journals", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/journals') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/journalsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/journals")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create journal model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/journals HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/journals',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/journals")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/journals') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/journalsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/journals")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"displayName": "Journal",
"properties": {
"journalCode": {
"description": "The number or code for the journal",
"displayName": "Journal Number",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 16 characters",
"field": "JournalCode"
}
]
}
},
"name": {
"description": "The name of the journal",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 40 characters",
"field": "Name"
}
]
}
},
"status": {
"description": "The status of the journal",
"displayName": "Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"displayName": "Journal",
"properties": {
"createdOn": {
"description": "The date the journal was created in the originating system",
"displayName": "Created On",
"required": true,
"type": "DateTime"
},
"hasChildren": {
"description": "If a journal has children, the journal is parent of those children journals",
"displayName": "Has Children",
"required": true,
"type": "Boolean"
},
"journalCode": {
"description": "The number or code for the journal",
"displayName": "Journal Number",
"required": true,
"type": "String"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"name": {
"description": "The name of the journal",
"displayName": "Name",
"required": true,
"type": "String"
},
"parentId": {
"description": "Identifier for the parent journal - empty if journal is the parent",
"displayName": "Parent Id",
"required": true,
"type": "String"
},
"status": {
"description": "The status of the journal",
"displayName": "Status",
"required": true,
"type": "String"
},
"type": {
"description": "The type of journal",
"displayName": "Type",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
GET
Get journal
{{baseUrl}}/companies/:companyId/data/journals/:journalId
QUERY PARAMS
journalId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/journals/:journalId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/journals/:journalId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/journals/:journalId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/journals/:journalId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/journals/:journalId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/journals/:journalId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/journals/:journalId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/journals/:journalId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/journals/:journalId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/journals/:journalId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/journals/:journalId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/journals/:journalId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journals/:journalId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/journals/:journalId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/journals/:journalId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/journals/:journalId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/journals/:journalId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journals/:journalId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/journals/:journalId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journals/:journalId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/journals/:journalId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/journals/:journalId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/journals/:journalId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/journals/:journalId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/journals/:journalId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/journals/:journalId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/journals/:journalId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/journals/:journalId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/journals/:journalId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/journals/:journalId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/journals/:journalId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/journals/:journalId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/journals/:journalId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/journals/:journalId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/journals/:journalId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/journals/:journalIdhttp GET {{baseUrl}}/companies/:companyId/data/journals/:journalIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/journals/:journalIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/journals/:journalId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List journals
{{baseUrl}}/companies/:companyId/data/journals
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/journals?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/journals" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/journals?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/journals?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/journals?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/journals?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/journals?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/journals?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/journals?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/journals?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/journals?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/journals?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journals',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/journals?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/journals?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/journals?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/journals?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journals',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/journals');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/journals',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/journals?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/journals?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/journals?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/journals?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/journals?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/journals');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/journals');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/journals?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/journals?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/journals?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/journals"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/journals"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/journals?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/journals') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/journals";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/journals?page='http GET '{{baseUrl}}/companies/:companyId/data/journals?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/journals?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/journals?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get payment method
{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/paymentMethods/:paymentMethodId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/paymentMethods/:paymentMethodId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/paymentMethods/:paymentMethodId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/paymentMethods/:paymentMethodId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodIdhttp GET {{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/paymentMethods/:paymentMethodId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List all payment methods
{{baseUrl}}/companies/:companyId/data/paymentMethods
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/paymentMethods?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/paymentMethods" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/paymentMethods?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/paymentMethods?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/paymentMethods?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/paymentMethods?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/paymentMethods?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/paymentMethods?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/paymentMethods?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/paymentMethods?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/paymentMethods?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/paymentMethods?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/paymentMethods',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/paymentMethods?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/paymentMethods?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/paymentMethods?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/paymentMethods?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/paymentMethods',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/paymentMethods');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/paymentMethods',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/paymentMethods?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/paymentMethods?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/paymentMethods?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/paymentMethods?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/paymentMethods?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/paymentMethods');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/paymentMethods');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/paymentMethods?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/paymentMethods?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/paymentMethods?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/paymentMethods"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/paymentMethods"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/paymentMethods?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/paymentMethods') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/paymentMethods";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/paymentMethods?page='http GET '{{baseUrl}}/companies/:companyId/data/paymentMethods?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/paymentMethods?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/paymentMethods?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create payment
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/payments HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/payments',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/payments", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/payments') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/paymentsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/payments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create payment model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/payments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/payments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/payments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/payments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/paymentshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/paymentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/paymentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/payments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must match the sum of the link amounts.",
"field": "Lines.Amount"
}
],
"warnings": []
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Invoice",
"required": false,
"type": "String",
"value": "Invoice"
},
{
"displayName": "CreditNote",
"required": false,
"type": "String",
"value": "CreditNote"
},
{
"displayName": "Other",
"required": false,
"type": "String",
"value": "Other"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Only one line may be specified",
"field": "Lines"
}
]
}
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of the line amounts.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"options": [
{
"displayName": "AED",
"required": false,
"type": "Array",
"value": "AED"
},
{
"displayName": "AFN",
"required": false,
"type": "Array",
"value": "AFN"
},
{
"displayName": "ALL",
"required": false,
"type": "Array",
"value": "ALL"
},
{
"displayName": "AMD",
"required": false,
"type": "Array",
"value": "AMD"
},
{
"displayName": "ANG",
"required": false,
"type": "Array",
"value": "ANG"
},
{
"displayName": "AOA",
"required": false,
"type": "Array",
"value": "AOA"
},
{
"displayName": "ARS",
"required": false,
"type": "Array",
"value": "ARS"
},
{
"displayName": "AUD",
"required": false,
"type": "Array",
"value": "AUD"
},
{
"displayName": "AWG",
"required": false,
"type": "Array",
"value": "AWG"
},
{
"displayName": "AZN",
"required": false,
"type": "Array",
"value": "AZN"
},
{
"displayName": "BAM",
"required": false,
"type": "Array",
"value": "BAM"
},
{
"displayName": "BBD",
"required": false,
"type": "Array",
"value": "BBD"
},
{
"displayName": "BDT",
"required": false,
"type": "Array",
"value": "BDT"
},
{
"displayName": "BGN",
"required": false,
"type": "Array",
"value": "BGN"
},
{
"displayName": "BHD",
"required": false,
"type": "Array",
"value": "BHD"
},
{
"displayName": "BIF",
"required": false,
"type": "Array",
"value": "BIF"
},
{
"displayName": "BMD",
"required": false,
"type": "Array",
"value": "BMD"
},
{
"displayName": "BND",
"required": false,
"type": "Array",
"value": "BND"
},
{
"displayName": "BOB",
"required": false,
"type": "Array",
"value": "BOB"
},
{
"displayName": "BRL",
"required": false,
"type": "Array",
"value": "BRL"
},
{
"displayName": "BSD",
"required": false,
"type": "Array",
"value": "BSD"
},
{
"displayName": "BTN",
"required": false,
"type": "Array",
"value": "BTN"
},
{
"displayName": "BWP",
"required": false,
"type": "Array",
"value": "BWP"
},
{
"displayName": "BYR",
"required": false,
"type": "Array",
"value": "BYR"
},
{
"displayName": "BZD",
"required": false,
"type": "Array",
"value": "BZD"
},
{
"displayName": "CAD",
"required": false,
"type": "Array",
"value": "CAD"
},
{
"displayName": "CDF",
"required": false,
"type": "Array",
"value": "CDF"
},
{
"displayName": "CHF",
"required": false,
"type": "Array",
"value": "CHF"
},
{
"displayName": "CLP",
"required": false,
"type": "Array",
"value": "CLP"
},
{
"displayName": "CNY",
"required": false,
"type": "Array",
"value": "CNY"
},
{
"displayName": "COP",
"required": false,
"type": "Array",
"value": "COP"
},
{
"displayName": "CRC",
"required": false,
"type": "Array",
"value": "CRC"
},
{
"displayName": "CUC",
"required": false,
"type": "Array",
"value": "CUC"
},
{
"displayName": "CUP",
"required": false,
"type": "Array",
"value": "CUP"
},
{
"displayName": "CVE",
"required": false,
"type": "Array",
"value": "CVE"
},
{
"displayName": "CZK",
"required": false,
"type": "Array",
"value": "CZK"
},
{
"displayName": "DJF",
"required": false,
"type": "Array",
"value": "DJF"
},
{
"displayName": "DKK",
"required": false,
"type": "Array",
"value": "DKK"
},
{
"displayName": "DOP",
"required": false,
"type": "Array",
"value": "DOP"
},
{
"displayName": "DZD",
"required": false,
"type": "Array",
"value": "DZD"
},
{
"displayName": "EGP",
"required": false,
"type": "Array",
"value": "EGP"
},
{
"displayName": "ERN",
"required": false,
"type": "Array",
"value": "ERN"
},
{
"displayName": "ETB",
"required": false,
"type": "Array",
"value": "ETB"
},
{
"displayName": "EUR",
"required": false,
"type": "Array",
"value": "EUR"
},
{
"displayName": "FJD",
"required": false,
"type": "Array",
"value": "FJD"
},
{
"displayName": "FKP",
"required": false,
"type": "Array",
"value": "FKP"
},
{
"displayName": "GBP",
"required": false,
"type": "Array",
"value": "GBP"
},
{
"displayName": "GEL",
"required": false,
"type": "Array",
"value": "GEL"
},
{
"displayName": "GGP",
"required": false,
"type": "Array",
"value": "GGP"
},
{
"displayName": "GHS",
"required": false,
"type": "Array",
"value": "GHS"
},
{
"displayName": "GIP",
"required": false,
"type": "Array",
"value": "GIP"
},
{
"displayName": "GMD",
"required": false,
"type": "Array",
"value": "GMD"
},
{
"displayName": "GNF",
"required": false,
"type": "Array",
"value": "GNF"
},
{
"displayName": "GTQ",
"required": false,
"type": "Array",
"value": "GTQ"
},
{
"displayName": "GYD",
"required": false,
"type": "Array",
"value": "GYD"
},
{
"displayName": "HKD",
"required": false,
"type": "Array",
"value": "HKD"
},
{
"displayName": "HNL",
"required": false,
"type": "Array",
"value": "HNL"
},
{
"displayName": "HRK",
"required": false,
"type": "Array",
"value": "HRK"
},
{
"displayName": "HTG",
"required": false,
"type": "Array",
"value": "HTG"
},
{
"displayName": "HUF",
"required": false,
"type": "Array",
"value": "HUF"
},
{
"displayName": "IDR",
"required": false,
"type": "Array",
"value": "IDR"
},
{
"displayName": "ILS",
"required": false,
"type": "Array",
"value": "ILS"
},
{
"displayName": "IMP",
"required": false,
"type": "Array",
"value": "IMP"
},
{
"displayName": "INR",
"required": false,
"type": "Array",
"value": "INR"
},
{
"displayName": "IQD",
"required": false,
"type": "Array",
"value": "IQD"
},
{
"displayName": "IRR",
"required": false,
"type": "Array",
"value": "IRR"
},
{
"displayName": "ISK",
"required": false,
"type": "Array",
"value": "ISK"
},
{
"displayName": "JEP",
"required": false,
"type": "Array",
"value": "JEP"
},
{
"displayName": "JMD",
"required": false,
"type": "Array",
"value": "JMD"
},
{
"displayName": "JOD",
"required": false,
"type": "Array",
"value": "JOD"
},
{
"displayName": "JPY",
"required": false,
"type": "Array",
"value": "JPY"
},
{
"displayName": "KES",
"required": false,
"type": "Array",
"value": "KES"
},
{
"displayName": "KGS",
"required": false,
"type": "Array",
"value": "KGS"
},
{
"displayName": "KHR",
"required": false,
"type": "Array",
"value": "KHR"
},
{
"displayName": "KMF",
"required": false,
"type": "Array",
"value": "KMF"
},
{
"displayName": "KPW",
"required": false,
"type": "Array",
"value": "KPW"
},
{
"displayName": "KRW",
"required": false,
"type": "Array",
"value": "KRW"
},
{
"displayName": "KWD",
"required": false,
"type": "Array",
"value": "KWD"
},
{
"displayName": "KYD",
"required": false,
"type": "Array",
"value": "KYD"
},
{
"displayName": "KZT",
"required": false,
"type": "Array",
"value": "KZT"
},
{
"displayName": "LAK",
"required": false,
"type": "Array",
"value": "LAK"
},
{
"displayName": "LBP",
"required": false,
"type": "Array",
"value": "LBP"
},
{
"displayName": "LKR",
"required": false,
"type": "Array",
"value": "LKR"
},
{
"displayName": "LRD",
"required": false,
"type": "Array",
"value": "LRD"
},
{
"displayName": "LSL",
"required": false,
"type": "Array",
"value": "LSL"
},
{
"displayName": "LYD",
"required": false,
"type": "Array",
"value": "LYD"
},
{
"displayName": "MAD",
"required": false,
"type": "Array",
"value": "MAD"
},
{
"displayName": "MDL",
"required": false,
"type": "Array",
"value": "MDL"
},
{
"displayName": "MGA",
"required": false,
"type": "Array",
"value": "MGA"
},
{
"displayName": "MKD",
"required": false,
"type": "Array",
"value": "MKD"
},
{
"displayName": "MMK",
"required": false,
"type": "Array",
"value": "MMK"
},
{
"displayName": "MNT",
"required": false,
"type": "Array",
"value": "MNT"
},
{
"displayName": "MOP",
"required": false,
"type": "Array",
"value": "MOP"
},
{
"displayName": "MRO",
"required": false,
"type": "Array",
"value": "MRO"
},
{
"displayName": "MUR",
"required": false,
"type": "Array",
"value": "MUR"
},
{
"displayName": "MVR",
"required": false,
"type": "Array",
"value": "MVR"
},
{
"displayName": "MWK",
"required": false,
"type": "Array",
"value": "MWK"
},
{
"displayName": "MXN",
"required": false,
"type": "Array",
"value": "MXN"
},
{
"displayName": "MYR",
"required": false,
"type": "Array",
"value": "MYR"
},
{
"displayName": "MZN",
"required": false,
"type": "Array",
"value": "MZN"
},
{
"displayName": "NAD",
"required": false,
"type": "Array",
"value": "NAD"
},
{
"displayName": "NGN",
"required": false,
"type": "Array",
"value": "NGN"
},
{
"displayName": "NIO",
"required": false,
"type": "Array",
"value": "NIO"
},
{
"displayName": "NOK",
"required": false,
"type": "Array",
"value": "NOK"
},
{
"displayName": "NPR",
"required": false,
"type": "Array",
"value": "NPR"
},
{
"displayName": "NZD",
"required": false,
"type": "Array",
"value": "NZD"
},
{
"displayName": "OMR",
"required": false,
"type": "Array",
"value": "OMR"
},
{
"displayName": "PAB",
"required": false,
"type": "Array",
"value": "PAB"
},
{
"displayName": "PEN",
"required": false,
"type": "Array",
"value": "PEN"
},
{
"displayName": "PGK",
"required": false,
"type": "Array",
"value": "PGK"
},
{
"displayName": "PHP",
"required": false,
"type": "Array",
"value": "PHP"
},
{
"displayName": "PKR",
"required": false,
"type": "Array",
"value": "PKR"
},
{
"displayName": "PLN",
"required": false,
"type": "Array",
"value": "PLN"
},
{
"displayName": "PYG",
"required": false,
"type": "Array",
"value": "PYG"
},
{
"displayName": "QAR",
"required": false,
"type": "Array",
"value": "QAR"
},
{
"displayName": "RON",
"required": false,
"type": "Array",
"value": "RON"
},
{
"displayName": "RSD",
"required": false,
"type": "Array",
"value": "RSD"
},
{
"displayName": "RUB",
"required": false,
"type": "Array",
"value": "RUB"
},
{
"displayName": "RWF",
"required": false,
"type": "Array",
"value": "RWF"
},
{
"displayName": "SAR",
"required": false,
"type": "Array",
"value": "SAR"
},
{
"displayName": "SBD",
"required": false,
"type": "Array",
"value": "SBD"
},
{
"displayName": "SCR",
"required": false,
"type": "Array",
"value": "SCR"
},
{
"displayName": "SDG",
"required": false,
"type": "Array",
"value": "SDG"
},
{
"displayName": "SEK",
"required": false,
"type": "Array",
"value": "SEK"
},
{
"displayName": "SGD",
"required": false,
"type": "Array",
"value": "SGD"
},
{
"displayName": "SHP",
"required": false,
"type": "Array",
"value": "SHP"
},
{
"displayName": "SLL",
"required": false,
"type": "Array",
"value": "SLL"
},
{
"displayName": "SOS",
"required": false,
"type": "Array",
"value": "SOS"
},
{
"displayName": "SPL",
"required": false,
"type": "Array",
"value": "SPL"
},
{
"displayName": "SRD",
"required": false,
"type": "Array",
"value": "SRD"
},
{
"displayName": "STD",
"required": false,
"type": "Array",
"value": "STD"
},
{
"displayName": "SVC",
"required": false,
"type": "Array",
"value": "SVC"
},
{
"displayName": "SYP",
"required": false,
"type": "Array",
"value": "SYP"
},
{
"displayName": "SZL",
"required": false,
"type": "Array",
"value": "SZL"
},
{
"displayName": "THB",
"required": false,
"type": "Array",
"value": "THB"
},
{
"displayName": "TJS",
"required": false,
"type": "Array",
"value": "TJS"
},
{
"displayName": "TMT",
"required": false,
"type": "Array",
"value": "TMT"
},
{
"displayName": "TND",
"required": false,
"type": "Array",
"value": "TND"
},
{
"displayName": "TOP",
"required": false,
"type": "Array",
"value": "TOP"
},
{
"displayName": "TRY",
"required": false,
"type": "Array",
"value": "TRY"
},
{
"displayName": "TTD",
"required": false,
"type": "Array",
"value": "TTD"
},
{
"displayName": "TVD",
"required": false,
"type": "Array",
"value": "TVD"
},
{
"displayName": "TWD",
"required": false,
"type": "Array",
"value": "TWD"
},
{
"displayName": "TZS",
"required": false,
"type": "Array",
"value": "TZS"
},
{
"displayName": "UAH",
"required": false,
"type": "Array",
"value": "UAH"
},
{
"displayName": "UGX",
"required": false,
"type": "Array",
"value": "UGX"
},
{
"displayName": "USD",
"required": false,
"type": "Array",
"value": "USD"
},
{
"displayName": "UYU",
"required": false,
"type": "Array",
"value": "UYU"
},
{
"displayName": "UZS",
"required": false,
"type": "Array",
"value": "UZS"
},
{
"displayName": "VEF",
"required": false,
"type": "Array",
"value": "VEF"
},
{
"displayName": "VND",
"required": false,
"type": "Array",
"value": "VND"
},
{
"displayName": "VUV",
"required": false,
"type": "Array",
"value": "VUV"
},
{
"displayName": "WST",
"required": false,
"type": "Array",
"value": "WST"
},
{
"displayName": "XAF",
"required": false,
"type": "Array",
"value": "XAF"
},
{
"displayName": "XCD",
"required": false,
"type": "Array",
"value": "XCD"
},
{
"displayName": "XDR",
"required": false,
"type": "Array",
"value": "XDR"
},
{
"displayName": "XOF",
"required": false,
"type": "Array",
"value": "XOF"
},
{
"displayName": "XPF",
"required": false,
"type": "Array",
"value": "XPF"
},
{
"displayName": "YER",
"required": false,
"type": "Array",
"value": "YER"
},
{
"displayName": "ZAR",
"required": false,
"type": "Array",
"value": "ZAR"
},
{
"displayName": "ZMW",
"required": false,
"type": "Array",
"value": "ZMW"
},
{
"displayName": "ZWD",
"required": false,
"type": "Array",
"value": "ZWD"
}
],
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Can be used for Payments on Account only",
"field": "Currency"
}
]
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Payment Amount must not exceed Invoice Amount Due or available Customer Credit",
"field": "Lines.Links"
},
{
"details": "Must be a Payment with one Invoice of PaymentOnAccount Link or two links of types Invoice and PaymentOnAccount",
"field": "Lines.Links"
}
]
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Only one line is supported",
"field": "Lines"
}
]
}
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"options": [
{
"displayName": "Australian Dollar",
"required": false,
"type": "String",
"value": "AUD"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Currency"
}
],
"warnings": []
}
},
"customerRef": {
"description": "Reference to the customer the payment has been sent by",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "CustomerRef.Id"
},
{
"details": "Must match the ID of an existing customer.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef"
}
],
"warnings": []
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Date"
}
],
"warnings": []
}
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines.Amount"
}
],
"warnings": []
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "Links.Amount"
},
{
"details": "Must be provided.",
"field": "Links.Amount"
}
],
"warnings": []
}
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Id"
}
],
"warnings": []
}
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"required": false,
"type": "String",
"value": "Invoice"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Type"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines.Links"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines"
}
],
"warnings": []
}
},
"reference": {
"description": "A user friendly reference for the payment",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be greater than 8 characters long.",
"field": "Reference"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided and must equal the sum of the link items amount.",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Precision must be maximum of two decimal places.",
"field": "TotalAmount"
},
{
"details": "Must be greater than zero.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing account of type 'Bank' OR type 'Asset' (with category 'FixedAsset'/'OthAsset'/'OthCurrAsset') OR type 'Liability' (with category 'LongTermLiab'/'OthCurrLiab') OR type 'Expense' (with category 'Expense'/'OthExpense')",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "If the currency is set make sure it's the same as the 'Invoice' and/or 'CreditMemo' currency",
"field": "Currency"
}
]
}
},
"customerRef": {
"description": "Reference to the customer the payment has been sent by",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "If the Link Type specified is an 'Invoice' or 'CreditNote' make sure the status is either 'PartiallyPaid' or 'Submitted'",
"field": "Links.Id"
}
]
}
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Invoice",
"required": false,
"type": "String",
"value": "Invoice"
},
{
"displayName": "Credit Note",
"required": false,
"type": "String",
"value": "CreditNote"
},
{
"displayName": "Payment On Account",
"required": false,
"type": "String",
"value": "PaymentOnAccount"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"reference": {
"description": "A user friendly reference for the payment",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "This field can be used to provide a tracking category id (Location only)",
"field": "Reference"
}
],
"warnings": [
{
"details": "The id format should be 'location-'",
"field": "Reference"
}
]
}
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be greater than zero",
"field": "TotalAmount"
},
{
"details": "Must be provided and must be equal to the sum of the lines amounts",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
} RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Not required if total amount of the payment is 0.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing 'Bank' or 'Other Current Asset' account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the default currency of the customer.",
"field": "Currency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code that matches the currency of the customer.",
"field": "Currency"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.",
"field": "CurrencyRate"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"customerRef": {
"description": "Reference to the customer the payment has been sent by",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing supplier.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Amount plus the sum of amounts in the links must equal 0",
"field": "Lines.Amount"
}
]
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Invoice",
"required": false,
"type": "String",
"value": "Invoice"
},
{
"displayName": "Credit Note",
"required": false,
"type": "String",
"value": "CreditNote"
},
{
"displayName": "Payment On Account",
"required": false,
"type": "String",
"value": "PaymentOnAccount"
}
],
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only 1 link with type 'PaymentOnAccount' may be specified per line, this line may contain no other links",
"field": "Links.Type"
},
{
"details": "Only 1 link with type 'Invoice' may be specified per line",
"field": "Links.Type"
}
]
}
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"reference": {
"description": "A user friendly reference for the payment",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 20 characters.",
"field": "Reference"
}
]
}
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the sum of amounts in the lines",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "Must match the ID of an existing Account.",
"field": "AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company",
"field": "Currency"
}
],
"warnings": []
}
},
"customerRef": {
"description": "Reference to the customer the payment has been sent by",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.",
"field": "CustomerRef"
}
],
"warnings": []
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Invoice",
"required": false,
"type": "String",
"value": "Invoice"
},
{
"displayName": "Credit Note",
"required": false,
"type": "String",
"value": "CreditNote"
},
{
"displayName": "Payment On Account",
"required": false,
"type": "String",
"value": "PaymentOnAccount"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": false,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentMethodRef": {
"description": "Reference to the method of this payment",
"displayName": "Payment Method Reference",
"properties": {
"id": {
"description": "The reference identifier for the payment method",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [
{
"details": "Must match the ID of an existing Account.",
"field": "AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company",
"field": "Currency"
}
],
"warnings": []
}
},
"customerRef": {
"description": "Reference to the customer the payment has been sent by",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.",
"field": "CustomerRef"
}
],
"warnings": []
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Invoice",
"required": false,
"type": "String",
"value": "Invoice"
},
{
"displayName": "Credit Note",
"required": false,
"type": "String",
"value": "CreditNote"
},
{
"displayName": "Payment On Account",
"required": false,
"type": "String",
"value": "PaymentOnAccount"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": false,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"paymentMethodRef": {
"description": "Reference to the method of this payment",
"displayName": "Payment Method Reference",
"properties": {
"id": {
"description": "The reference identifier for the payment method",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "The bank account to pay this invoice from.",
"displayName": "Bank Account",
"properties": {
"id": {
"description": "Nominal code of the bank account.",
"displayName": "Account Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing bank account and have a max length of 8 characters.",
"field": "accountRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"customerRef": {
"description": "Customer to be paid.",
"displayName": "Customer",
"properties": {
"id": {
"description": "Identifier of the customer.",
"displayName": "Customer Id",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing customer and have a max length of 8 characters.",
"field": "customerRef.id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"date": {
"description": "The date this payment was issued.",
"displayName": "Issue Date",
"required": true,
"type": "Number"
},
"lines": {
"description": "Line items of the payment.",
"displayName": "Line Items",
"properties": {
"amount": {
"description": "The amount of this line item",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "this must equal the negative of the sum of the link amounts"
}
],
"warnings": []
}
},
"links": {
"description": "Links to the invoice being paid.",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount to be added to the value of the invoice",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "When paying off an invoice, this value will be negative"
}
],
"warnings": []
}
},
"id": {
"description": "The ID of the invoice to pay",
"displayName": "Invoice Id",
"required": true,
"type": "String"
},
"type": {
"description": "The type of the item to be paid",
"displayName": "Payment Link Type",
"options": [
{
"displayName": "Invoice",
"required": false,
"type": "String",
"value": "Invoice"
},
{
"displayName": "Payment On Account",
"required": false,
"type": "String",
"value": "PaymentOnAccount"
},
{
"displayName": "Refund",
"required": false,
"type": "String",
"value": "Refund"
},
{
"displayName": "Credit Note",
"required": false,
"type": "String",
"value": "CreditNote"
},
{
"displayName": "Payment",
"required": false,
"type": "String",
"value": "Payment"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Sage 50 only supports one line item per invoice payment so all lines will be merged together in the response."
}
],
"warnings": []
}
},
"note": {
"description": "A description of the payment.",
"displayName": "Note",
"required": false,
"type": "Number"
},
"reference": {
"description": "The user reference for this invoice payment.",
"displayName": "Reference",
"required": false,
"type": "Number"
},
"totalAmount": {
"description": "The total amount being paid to the customer.",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "This must equal the sum of the line amounts"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing Account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Required unless the Payment is only allocating a Credit Note.",
"field": "AccountRef"
}
]
}
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If supplied, must match the currency of the customer.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"customerRef": {
"description": "Reference to the customer the payment has been sent by",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing Customer.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Date"
}
],
"warnings": []
}
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Amount"
}
],
"warnings": [
{
"details": "Must be greater than zero except when Type is Invoice",
"field": "Links.Amount"
}
]
}
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Id"
}
],
"warnings": []
}
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Invoice",
"required": false,
"type": "String",
"value": "Invoice"
},
{
"displayName": "PaymentOnAccount",
"required": false,
"type": "String",
"value": "PaymentOnAccount"
},
{
"displayName": "Refund",
"required": false,
"type": "String",
"value": "Refund"
},
{
"displayName": "CreditNote",
"required": false,
"type": "String",
"value": "CreditNote"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Type"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines.Links"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not be longer than 25 characters.",
"field": "Note"
}
]
}
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Must be zero when allocating against Invoices using a Credit Note only.",
"field": "TotalAmount"
},
{
"details": "Must equal the sum of the link items amount.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "For undeposited payments use the GL account record number to charge.",
"field": "AccountRef.Id"
},
{
"details": "To charge either a savings, checking or credit card account use its associated GL account number.",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Is required if currency is provided.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"customerRef": {
"description": "Reference to the customer the payment has been sent by",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be an existing customer ID in Sage Intacct.",
"field": "CustomerRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must occur after the date the invoice was created.",
"field": "Date"
}
],
"warnings": []
}
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "When added together with the sum of the Links.Amount the total must be zero.",
"field": "Lines.Amount"
}
],
"warnings": []
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must not be more than the total amount due for an invoice or the available funds in the account to be charged.",
"field": "Links.Amount"
}
],
"warnings": []
}
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be a valid Record No. from accounts receivable of either an invoice for an 'Invoice', adjustment for a 'CreditNote' or an advance for a 'PaymentOnAccount' in Sage Intacct.",
"field": "Links.Id"
},
{
"details": "Must be an integer.",
"field": "Links.Id"
},
{
"details": "Must related to CustomerRef.Id in Sage Intacct.",
"field": "Links.Id"
}
],
"warnings": []
}
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be one of Invoiceor CreditNoteor PaymentOnAccount.",
"field": "Links.Type"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "No more than two links can exist when paying for an invoice via a CreditNoteor PaymentOnAccount.",
"field": "Lines.Links"
},
{
"details": "Must contain only one Invoice.",
"field": "Lines.Links"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must contain at least one payment line.",
"field": "Lines"
}
],
"warnings": []
}
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must be less than 1000 characters.",
"field": "Note"
}
],
"warnings": []
}
},
"paymentMethodRef": {
"description": "Reference to the method of this payment",
"displayName": "Payment Method Reference",
"properties": {
"id": {
"description": "The reference identifier for the payment method",
"displayName": "Identifier",
"options": [
{
"displayName": "Printed Check",
"required": false,
"type": "String",
"value": "1"
},
{
"displayName": "Credit Card",
"required": false,
"type": "String",
"value": "3"
},
{
"displayName": "EFT",
"required": false,
"type": "String",
"value": "5"
},
{
"displayName": "Cash",
"required": false,
"type": "String",
"value": "6"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"reference": {
"description": "A user friendly reference for the payment",
"displayName": "Reference",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Can be used to set the Document/Check No. in Sage Intacct.",
"field": "Reference"
}
],
"warnings": []
}
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must equal the sum of Lines.Amount.",
"field": "TotalAmount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Sage Intacct handles allocated payments only."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"customerRef": {
"description": "Reference to the customer the payment has been sent by",
"displayName": "Customer Reference",
"properties": {
"companyName": {
"description": "The name of the customer referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"allocatedOnDate": {
"description": "The date the payment was allocated",
"displayName": "Allocated On Date",
"required": true,
"type": "DateTime"
},
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the currency of the linked transaction",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Array"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": true,
"type": "String"
},
"paymentMethodRef": {
"description": "Reference to the method of this payment",
"displayName": "Payment Method Reference",
"properties": {
"id": {
"description": "The reference identifier for the payment method",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the payment method referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"reference": {
"description": "A user friendly reference for the payment",
"displayName": "Reference",
"required": true,
"type": "String"
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be either a type of BANK account or enable payments must be switched on.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "AccountRef"
}
],
"warnings": []
}
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": false,
"type": "Number"
},
"customerRef": {
"description": "Reference to the customer the payment has been sent by",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "CustomerRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "CustomerRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "CustomerRef"
}
],
"warnings": []
}
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Date"
}
],
"warnings": []
}
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"amount": {
"description": "The total amount for the line in the payment currency",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines.Amount"
}
],
"warnings": []
}
},
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Amount"
}
],
"warnings": []
}
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Invoice and Credit Note ID must be provided in order to allocate a Credit Note to an Invoice.",
"field": "Links.Id"
},
{
"details": "Must be provided.",
"field": "Links.Id"
}
],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "Links.Id"
}
]
}
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Invoice",
"required": false,
"type": "String",
"value": "Invoice"
},
{
"displayName": "CreditNote",
"required": false,
"type": "String",
"value": "CreditNote"
},
{
"displayName": "Payment",
"required": false,
"type": "String",
"value": "Payment"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Links.Type"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines.Links"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Lines"
}
],
"warnings": []
}
},
"reference": {
"description": "A user friendly reference for the payment",
"displayName": "Reference",
"required": false,
"type": "String"
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be provided and must equal the sum of the link items amount.",
"field": "TotalAmount"
}
],
"warnings": [
{
"details": "Must be greater than 0, unless the payment is a credit note allocation.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"displayName": "Payment",
"properties": {
"accountRef": {
"description": "Reference to the nominal account the payment is linked to",
"displayName": "Nominal Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "AccountRef.ID is required when making a payment to an invoice and/or a payment on account",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"currency": {
"description": "Currency of the payment",
"displayName": "Currency",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "must match the currency of any invoices or credit notes",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"displayName": "Currency Exchange Rate",
"required": true,
"type": "Number"
},
"customerRef": {
"description": "Reference to the customer the payment has been sent by",
"displayName": "Customer Reference",
"properties": {
"id": {
"description": "The reference identifier for the customer",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"date": {
"description": "The date the payment was recorded",
"displayName": "Date",
"required": true,
"type": "DateTime"
},
"lines": {
"description": "A collection of payment lines",
"displayName": "Lines",
"properties": {
"links": {
"description": "A collection of linked transactions",
"displayName": "Links",
"properties": {
"amount": {
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "the sum of all link amounts must equal the negated total amount of the payment",
"field": "Links.Amount"
}
]
}
},
"id": {
"description": "The identifier for the referenced transaction",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"type": {
"description": "The type of transaction that is being linked",
"displayName": "Link Type",
"options": [
{
"displayName": "Invoice",
"required": false,
"type": "Array"
},
{
"displayName": "CreditNote",
"required": false,
"type": "Array"
},
{
"displayName": "PaymentOnAccount",
"required": false,
"type": "Array"
}
],
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "if a credit note link is provided, exactly one invoice link must be provided, otherwise unlimited invoice links and one payment on account link are allowed",
"field": "Lines.Links"
}
]
}
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional text based information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"totalAmount": {
"description": "The total amount of the payment, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "must be greater than or equal to 0",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}
GET
Get payment
{{baseUrl}}/companies/:companyId/data/payments/:paymentId
QUERY PARAMS
paymentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/payments/:paymentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/payments/:paymentId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/payments/:paymentId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/payments/:paymentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/payments/:paymentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/payments/:paymentId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/payments/:paymentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/payments/:paymentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/payments/:paymentId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/payments/:paymentId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/payments/:paymentId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/payments/:paymentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/payments/:paymentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/payments/:paymentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/payments/:paymentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/payments/:paymentId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/payments/:paymentId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/payments/:paymentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/payments/:paymentId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/payments/:paymentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/payments/:paymentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/payments/:paymentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/payments/:paymentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/payments/:paymentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/payments/:paymentId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/payments/:paymentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/payments/:paymentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/payments/:paymentId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/payments/:paymentId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/payments/:paymentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/payments/:paymentId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/payments/:paymentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/payments/:paymentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/payments/:paymentId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/payments/:paymentId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/payments/:paymentIdhttp GET {{baseUrl}}/companies/:companyId/data/payments/:paymentIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/payments/:paymentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/payments/:paymentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List payments
{{baseUrl}}/companies/:companyId/data/payments
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/payments?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/payments" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/payments?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/payments?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/payments?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/payments?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/payments?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/payments?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/payments?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/payments?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/payments?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/payments?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/payments',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/payments?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/payments?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/payments?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/payments?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/payments',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/payments');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/payments',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/payments?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/payments?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/payments?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/payments?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/payments?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/payments');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/payments');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/payments?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/payments?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/payments?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/payments"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/payments"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/payments?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/payments') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/payments";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/payments?page='http GET '{{baseUrl}}/companies/:companyId/data/payments?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/payments?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/payments?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create purchase order
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/purchaseOrders HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/purchaseOrders',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/purchaseOrders", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/purchaseOrders') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrdersimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create-update purchase order model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/purchaseOrders HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/purchaseOrders',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/purchaseOrders")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/purchaseOrders') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrdershttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrderswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrdersimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/purchaseOrders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase",
"displayName": "Purchase Order",
"properties": {
"currency": {
"description": "Currency of the purchase order",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "Rate for converting the total amount of the purchase order into the base currency for the company",
"displayName": "Currency Rate",
"required": true,
"type": "Number"
},
"expectedDeliveryDate": {
"description": "Expected delivery date for any goods that have been ordered",
"displayName": "Expected Delivery Date",
"required": false,
"type": "DateTime"
},
"issueDate": {
"description": "Date of the purchase order as recorded in the accounting platform",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "Collection of items that relate to the purchase order",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the account to which the line item is linked",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not be a bank account",
"field": "LineItems.AccountRef"
},
{
"details": "Should only be specified when pushing an expense",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name for the goods that have been ordered",
"displayName": "Description",
"required": false,
"type": "String"
},
"itemRef": {
"description": "Reference to the product or inventory item to which the line item is linked",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Should only be specified when pushing an item (not an expense)",
"field": "LineItems.ItemRef"
}
]
}
},
"quantity": {
"description": "Number of units of the goods that have been ordered",
"displayName": "Quantity",
"required": false,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate to which the line item is linked",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Should be specified when item type is not 'Discount'",
"field": "LineItems.TaxRateRef"
}
]
}
},
"trackingCategoryRefs": {
"description": "Reference to the tracking categories to which the line item is linked",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "Price of each unit of the goods",
"displayName": "Unit Amount",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"status": {
"description": "Current state of the purchase order",
"displayName": "Status",
"options": [
{
"displayName": "Open",
"required": false,
"type": "String",
"value": "Open"
}
],
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Supplier that the purchase order is recorded against in the accounting system",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase",
"displayName": "Purchase Order",
"properties": {
"currency": {
"description": "Currency of the purchase order",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the default currency of the customer",
"field": "Currency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code that matches the currency of the customer",
"field": "Currency"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "Currency"
}
]
}
},
"currencyRate": {
"description": "Rate for converting the total amount of the purchase order into the base currency for the company",
"displayName": "Currency Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.",
"field": "CurrencyRate"
},
{
"details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"expectedDeliveryDate": {
"description": "Expected delivery date for any goods that have been ordered",
"displayName": "Expected Delivery Date",
"required": false,
"type": "DateTime"
},
"issueDate": {
"description": "Date of the purchase order as recorded in the accounting platform",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "Collection of items that relate to the purchase order",
"displayName": "Line Items",
"properties": {
"description": {
"description": "Friendly name for the goods that have been ordered",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"itemRef": {
"description": "Reference to the product or inventory item to which the line item is linked",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.ItemRef"
}
]
}
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "Number of units of the goods that have been ordered",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate to which the line item is linked",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only valid for UK or CA versions of QuickBooks Desktop with VAT enabled, will be ignored in US version",
"field": "TaxRateRef.Id"
},
{
"details": "Must match the ID of an existing tax rate",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"trackingCategoryRefs": {
"description": "Reference to the tracking categories to which the line item is linked",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tracking category.",
"field": "TrackingCategoryRefs.Id"
}
]
}
}
},
"required": false,
"type": "Array"
},
"unitAmount": {
"description": "Price of each unit of the goods",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4000 characters.",
"field": "Note"
}
]
}
},
"paymentDueDate": {
"description": "Date the supplier is due to be paid",
"displayName": "Payment Due Date",
"required": false,
"type": "DateTime"
},
"purchaseOrderNumber": {
"description": "Friendly reference for the purchase order, commonly generated by the accounting platform",
"displayName": "Purchase Order Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 11 characters.",
"field": "PurchaseOrderNumber"
}
]
}
},
"shipTo": {
"description": "Delivery details for any goods that have been ordered",
"displayName": "Ship To",
"properties": {
"address": {
"description": "Delivery address for any goods that have been ordered",
"displayName": "Address",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 31 characters.",
"field": "Address.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 31 characters.",
"field": "Address.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 41 characters.",
"field": "Address.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 41 characters.",
"field": "Address.Line2"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 13 characters.",
"field": "Address.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 21 characters.",
"field": "Address.Region"
}
]
}
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Delivery Address",
"required": false,
"type": "String",
"value": "Delivery"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Only 1 address each of type(s) Delivery may be specified.",
"field": "Address.Type"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Object"
}
},
"required": false,
"type": "Object"
},
"status": {
"description": "Current state of the purchase order",
"displayName": "Status",
"options": [
{
"displayName": "Open",
"required": false,
"type": "String",
"value": "Open"
}
],
"required": true,
"type": "String"
},
"supplierRef": {
"description": "Supplier that the purchase order is recorded against in the accounting system",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing supplier.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "Total amount of the purchase order, including discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the total amount in the line items.",
"field": "TotalAmount"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase",
"displayName": "Purchase Order",
"properties": {
"currency": {
"description": "Currency of the purchase order",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "Rate for converting the total amount of the purchase order into the base currency for the company",
"displayName": "Currency Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if Currency is not the base currency.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"deliveryDate": {
"description": "Actual delivery date for any goods that have been ordered",
"displayName": "Delivery Date",
"required": false,
"type": "DateTime"
},
"expectedDeliveryDate": {
"description": "Expected delivery date for any goods that have been ordered",
"displayName": "Expected Delivery Date",
"required": false,
"type": "DateTime"
},
"issueDate": {
"description": "Date of the purchase order as recorded in the accounting platform",
"displayName": "Issue Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "If the issue date is not supplied, the current date on the server is used",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "Collection of items that relate to the purchase order",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the account to which the line item is linked",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if the expense line is account based. If AccountRef is specified, ItemRef must be null.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name for the goods that have been ordered",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not be longer than 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"discountAmount": {
"description": "Value of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"discountPercentage": {
"description": "Percentage rate (from 0 to 100) of any discounts applied to the unit amount",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"itemRef": {
"description": "Reference to the product or inventory item to which the line item is linked",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if the expense line is item based. If ItemRef is specified, AccountRef must be null.",
"field": "ItemRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "Number of units of the goods that have been ordered",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "Amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate to which the line item is linked",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tax code.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"unitAmount": {
"description": "Price of each unit of the goods",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"purchaseOrderNumber": {
"description": "Friendly reference for the purchase order, commonly generated by the accounting platform",
"displayName": "Purchase Order Number",
"required": false,
"type": "String"
},
"shipTo": {
"description": "Delivery details for any goods that have been ordered",
"displayName": "Ship To",
"required": false,
"type": "Object"
},
"status": {
"description": "Current state of the purchase order",
"displayName": "Status",
"options": [
{
"displayName": "Open",
"required": false,
"type": "String",
"value": "Open"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "QuickBooks Online only supports \"Open\" as a status for new purchase orders.",
"field": "Status"
}
],
"warnings": []
}
},
"supplierRef": {
"description": "Supplier that the purchase order is recorded against in the accounting system",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase",
"displayName": "Purchase Order",
"properties": {
"currency": {
"description": "Currency of the purchase order",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if multi-currency is enabled for the company.",
"field": "Currency"
}
],
"warnings": []
}
},
"currencyRate": {
"description": "Rate for converting the total amount of the purchase order into the base currency for the company",
"displayName": "Currency Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "Required if Currency is not the base currency.",
"field": "CurrencyRate"
}
],
"warnings": []
}
},
"deliveryDate": {
"description": "Actual delivery date for any goods that have been ordered",
"displayName": "Delivery Date",
"required": false,
"type": "DateTime"
},
"expectedDeliveryDate": {
"description": "Expected delivery date for any goods that have been ordered",
"displayName": "Expected Delivery Date",
"required": false,
"type": "DateTime"
},
"issueDate": {
"description": "Date of the purchase order as recorded in the accounting platform",
"displayName": "Issue Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "If the issue date is not supplied, the current date on the server is used",
"field": "IssueDate"
}
],
"warnings": []
}
},
"lineItems": {
"description": "Collection of items that relate to the purchase order",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the account to which the line item is linked",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if the expense line is account based. If AccountRef is specified, ItemRef must be null.",
"field": "AccountRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name for the goods that have been ordered",
"displayName": "Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Should not be longer than 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"discountAmount": {
"description": "Value of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"discountPercentage": {
"description": "Percentage rate (from 0 to 100) of any discounts applied to the unit amount",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"itemRef": {
"description": "Reference to the product or inventory item to which the line item is linked",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Required if the expense line is item based. If ItemRef is specified, AccountRef must be null.",
"field": "ItemRef.Id"
}
],
"warnings": [
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "Number of units of the goods that have been ordered",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "Amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate to which the line item is linked",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tax code.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"unitAmount": {
"description": "Price of each unit of the goods",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"note": {
"description": "Any additional information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String"
},
"purchaseOrderNumber": {
"description": "Friendly reference for the purchase order, commonly generated by the accounting platform",
"displayName": "Purchase Order Number",
"required": false,
"type": "String"
},
"shipTo": {
"description": "Delivery details for any goods that have been ordered",
"displayName": "Ship To",
"required": false,
"type": "Object"
},
"status": {
"description": "Current state of the purchase order",
"displayName": "Status",
"options": [
{
"displayName": "Open",
"required": false,
"type": "String",
"value": "Open"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "QuickBooks Online only supports \"Open\" as a status for new purchase orders.",
"field": "Status"
}
],
"warnings": []
}
},
"supplierRef": {
"description": "Supplier that the purchase order is recorded against in the accounting system",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase",
"displayName": "Purchase Order",
"properties": {
"currency": {
"description": "Currency of the purchase order",
"displayName": "Currency",
"required": true,
"type": "String"
},
"currencyRate": {
"description": "Rate for converting the total amount of the purchase order into the base currency for the company",
"displayName": "Currency Rate",
"required": true,
"type": "Number"
},
"deliveryDate": {
"description": "Actual delivery date for any goods that have been ordered",
"displayName": "Delivery Date",
"required": true,
"type": "DateTime"
},
"expectedDeliveryDate": {
"description": "Expected delivery date for any goods that have been ordered",
"displayName": "Expected Delivery Date",
"required": true,
"type": "DateTime"
},
"issueDate": {
"description": "Date of the purchase order as recorded in the accounting platform",
"displayName": "Issue Date",
"required": true,
"type": "DateTime"
},
"lineItems": {
"description": "Collection of items that relate to the purchase order",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the account to which the line item is linked",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the account",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"description": {
"description": "Friendly name for the goods that have been ordered",
"displayName": "Description",
"required": true,
"type": "String"
},
"discountAmount": {
"description": "Value of any discounts applied",
"displayName": "Discount Amount",
"required": true,
"type": "Number"
},
"discountPercentage": {
"description": "Percentage rate (from 0 to 100) of any discounts applied to the unit amount",
"displayName": "Discount Percentage",
"required": true,
"type": "Number"
},
"itemRef": {
"description": "Reference to the product or inventory item to which the line item is linked",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the item referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"quantity": {
"description": "Number of units of the goods that have been ordered",
"displayName": "Quantity",
"required": true,
"type": "Number"
},
"subTotal": {
"description": "Amount of the line, inclusive of discounts but exclusive of tax",
"displayName": "Sub Total",
"required": true,
"type": "Number"
},
"taxAmount": {
"description": "Amount of tax for the line",
"displayName": "Tax Amount",
"required": true,
"type": "Number"
},
"taxRateRef": {
"description": "Reference to the tax rate to which the line item is linked",
"displayName": "Tax Rate Reference",
"properties": {
"effectiveTaxRate": {
"description": "The total applied tax percentage, including compounding details",
"displayName": "Effective Tax Rate",
"required": true,
"type": "Number"
},
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the tax rate referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "The total amount of the line, inclusive of discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"trackingCategoryRefs": {
"description": "Reference to the tracking categories to which the line item is linked",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"unitAmount": {
"description": "Price of each unit of the goods",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"note": {
"description": "Any additional information associated with the payment",
"displayName": "Note",
"required": true,
"type": "String"
},
"paymentDueDate": {
"description": "Date the supplier is due to be paid",
"displayName": "Payment Due Date",
"required": true,
"type": "DateTime"
},
"purchaseOrderNumber": {
"description": "Friendly reference for the purchase order, commonly generated by the accounting platform",
"displayName": "Purchase Order Number",
"required": true,
"type": "String"
},
"shipTo": {
"description": "Delivery details for any goods that have been ordered",
"displayName": "Ship To",
"properties": {
"address": {
"description": "Delivery address for any goods that have been ordered",
"displayName": "Address",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": true,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": true,
"type": "String"
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": true,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": true,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": true,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": true,
"type": "String"
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"contact": {
"description": "Details of the named contact at the delivery address",
"displayName": "Contact",
"properties": {
"email": {
"description": "Email address of the contact at the delivery address",
"displayName": "Email",
"required": true,
"type": "String"
},
"name": {
"description": "Name of the contact at the delivery address",
"displayName": "Name",
"required": true,
"type": "String"
},
"phone": {
"description": "Phone number of the contact at the delivery address",
"displayName": "Phone",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
},
"status": {
"description": "Current state of the purchase order",
"displayName": "Status",
"required": true,
"type": "String"
},
"subTotal": {
"description": "Total amount of the purchase order, including discounts but excluding tax",
"displayName": "Sub Total",
"required": true,
"type": "Number"
},
"supplierRef": {
"description": "Supplier that the purchase order is recorded against in the accounting system",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"supplierName": {
"description": "The name of the supplier referenced by the identifier",
"displayName": "Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"totalAmount": {
"description": "Total amount of the purchase order, including discounts and tax",
"displayName": "Total Amount",
"required": true,
"type": "Number"
},
"totalDiscount": {
"description": "Total value of any discounts applied to the purchase order",
"displayName": "Total Discount",
"required": true,
"type": "Number"
},
"totalTaxAmount": {
"description": "Total amount of tax included in the purchase order",
"displayName": "Total Tax Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase",
"displayName": "Purchase Order",
"properties": {
"currency": {
"description": "Currency of the purchase order",
"displayName": "Currency",
"required": false,
"type": "String"
},
"currencyRate": {
"description": "Rate for converting the total amount of the purchase order into the base currency for the company",
"displayName": "Currency Rate",
"required": false,
"type": "Number",
"validation": {
"information": [
{
"details": "If no rate is specified, the Xero day rate will be applied.",
"field": "CurrencyRate",
"ref": "https://central.xero.com/s/#CurrencySettings$Rates"
}
],
"warnings": []
}
},
"deliveryDate": {
"description": "Actual delivery date for any goods that have been ordered",
"displayName": "Delivery Date",
"required": false,
"type": "DateTime"
},
"expectedDeliveryDate": {
"description": "Expected delivery date for any goods that have been ordered",
"displayName": "Expected Delivery Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [],
"warnings": [
{
"details": "Can only be provided for Purchase Orders with an Open status.",
"field": "ExpectedDeliveryDate"
}
]
}
},
"issueDate": {
"description": "Date of the purchase order as recorded in the accounting platform",
"displayName": "Issue Date",
"required": false,
"type": "DateTime"
},
"lineItems": {
"description": "Collection of items that relate to the purchase order",
"displayName": "Line Items",
"properties": {
"accountRef": {
"description": "Reference to the account to which the line item is linked",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The identifier for the account",
"displayName": "Account ID",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing account.",
"field": "AccountRef.Id"
},
{
"details": "Must be provided.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided.",
"field": "LineItems.AccountRef"
}
]
}
},
"description": {
"description": "Friendly name for the goods that have been ordered",
"displayName": "Description",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not exceed 4000 characters.",
"field": "LineItems.Description"
}
]
}
},
"discountAmount": {
"description": "Value of any discounts applied",
"displayName": "Discount Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match DiscountPercentage if supplied",
"field": "LineItems.DiscountAmount"
}
]
}
},
"discountPercentage": {
"description": "Percentage rate (from 0 to 100) of any discounts applied to the unit amount",
"displayName": "Discount Percentage",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match DiscountAmount if supplied",
"field": "LineItems.DiscountPercentage"
}
]
}
},
"itemRef": {
"description": "Reference to the product or inventory item to which the line item is linked",
"displayName": "Item Reference",
"properties": {
"id": {
"description": "The reference identifier for the item",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "ItemRef.Id"
},
{
"details": "Must match the ID of an existing item.",
"field": "ItemRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"quantity": {
"description": "Number of units of the goods that have been ordered",
"displayName": "Quantity",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not be negative",
"field": "LineItems.Quantity"
}
]
}
},
"taxRateRef": {
"description": "Reference to the tax rate to which the line item is linked",
"displayName": "Tax Rate Reference",
"properties": {
"id": {
"description": "The reference identifier for the tax rate",
"displayName": "Identifier",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing tax rate.",
"field": "TaxRateRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "Reference to the tracking categories to which the line item is linked",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided.",
"field": "TrackingCategoryRefs.Id"
}
]
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Tracking categories must not have the same parent tracking category.",
"field": "LineItems.TrackingCategoryRefs"
},
{
"details": "Maximum of 2 Tracking Categories.",
"field": "LineItems.TrackingCategoryRefs"
}
]
}
},
"unitAmount": {
"description": "Price of each unit of the goods",
"displayName": "Unit Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided and must not be empty",
"field": "LineItems"
}
]
}
},
"note": {
"description": "Any additional information associated with the payment",
"displayName": "Note",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must not exceed 500 characters.",
"field": "Note"
}
]
}
},
"purchaseOrderNumber": {
"description": "Friendly reference for the purchase order, commonly generated by the accounting platform",
"displayName": "Purchase Order Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be unique.",
"field": "PurchaseOrderNumber"
}
]
}
},
"shipTo": {
"description": "Delivery details for any goods that have been ordered",
"displayName": "Ship To",
"properties": {
"address": {
"description": "Delivery address for any goods that have been ordered",
"displayName": "Address",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String"
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Object"
},
"contact": {
"description": "Details of the named contact at the delivery address",
"displayName": "Contact",
"properties": {
"name": {
"description": "Name of the contact at the delivery address",
"displayName": "Name",
"required": false,
"type": "String"
},
"phone": {
"description": "Phone number of the contact at the delivery address",
"displayName": "Phone",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Object"
}
},
"required": false,
"type": "Object"
},
"status": {
"description": "Current state of the purchase order",
"displayName": "Status",
"options": [
{
"displayName": "Draft",
"required": false,
"type": "String",
"value": "Draft"
},
{
"displayName": "Open",
"required": false,
"type": "String",
"value": "Open"
},
{
"displayName": "Closed",
"required": false,
"type": "String",
"value": "Closed"
}
],
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "ExpectedDeliveryDate can only be provided for Purchase Orders with an Open status.",
"field": "Status"
},
{
"details": "Must be provided.",
"field": "Status"
}
]
}
},
"subTotal": {
"description": "Total amount of the purchase order, including discounts but excluding tax",
"displayName": "Sub Total",
"required": false,
"type": "Number"
},
"supplierRef": {
"description": "Supplier that the purchase order is recorded against in the accounting system",
"displayName": "Supplier Reference",
"properties": {
"id": {
"description": "The reference identifier for the supplier",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a valid GUID.",
"field": "SupplierRef.Id"
},
{
"details": "Must match the ID of an existing Supplier.",
"field": "SupplierRef.Id"
},
{
"details": "Must be provided.",
"field": "SupplierRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided.",
"field": "SupplierRef"
}
]
}
},
"totalAmount": {
"description": "Total amount of the purchase order, including discounts and tax",
"displayName": "Total Amount",
"required": false,
"type": "Number"
},
"totalDiscount": {
"description": "Total value of any discounts applied to the purchase order",
"displayName": "Total Discount",
"required": false,
"type": "Number"
}
},
"required": true,
"type": "Object"
}
GET
Get purchase order
{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId
QUERY PARAMS
purchaseOrderId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/purchaseOrders/:purchaseOrderId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/purchaseOrders/:purchaseOrderId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/purchaseOrders/:purchaseOrderId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/purchaseOrders/:purchaseOrderId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderIdhttp GET {{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/purchaseOrders/:purchaseOrderId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List purchase orders
{{baseUrl}}/companies/:companyId/data/purchaseOrders
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/purchaseOrders" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/purchaseOrders?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/purchaseOrders?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/purchaseOrders?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/purchaseOrders?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/purchaseOrders?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/purchaseOrders',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/purchaseOrders?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/purchaseOrders',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/purchaseOrders');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/purchaseOrders',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/purchaseOrders?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/purchaseOrders');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/purchaseOrders');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/purchaseOrders?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/purchaseOrders"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/purchaseOrders"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/purchaseOrders') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/purchaseOrders";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/purchaseOrders?page='http GET '{{baseUrl}}/companies/:companyId/data/purchaseOrders?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/purchaseOrders?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/purchaseOrders?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Update purchase order
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId"
payload = {}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId"
payload <- "{}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http PUT {{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderIdimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/purchaseOrders/:purchaseOrderId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Aged creditors report available
{{baseUrl}}/companies/:companyId/reports/agedCreditor/available
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/reports/agedCreditor/available");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/reports/agedCreditor/available")require "http/client"
url = "{{baseUrl}}/companies/:companyId/reports/agedCreditor/available"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/reports/agedCreditor/available"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/reports/agedCreditor/available");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/reports/agedCreditor/available"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/reports/agedCreditor/available HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/reports/agedCreditor/available")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/reports/agedCreditor/available"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/reports/agedCreditor/available")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/reports/agedCreditor/available")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/reports/agedCreditor/available');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedCreditor/available'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/reports/agedCreditor/available';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/reports/agedCreditor/available',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/reports/agedCreditor/available")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/reports/agedCreditor/available',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedCreditor/available'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/reports/agedCreditor/available');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedCreditor/available'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/reports/agedCreditor/available';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/reports/agedCreditor/available"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/reports/agedCreditor/available" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/reports/agedCreditor/available",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/reports/agedCreditor/available');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/reports/agedCreditor/available');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/reports/agedCreditor/available');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/reports/agedCreditor/available' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/reports/agedCreditor/available' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/reports/agedCreditor/available")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/reports/agedCreditor/available"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/reports/agedCreditor/available"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/reports/agedCreditor/available")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/reports/agedCreditor/available') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/reports/agedCreditor/available";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/reports/agedCreditor/availablehttp GET {{baseUrl}}/companies/:companyId/reports/agedCreditor/availablewget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/reports/agedCreditor/availableimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/reports/agedCreditor/available")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Aged creditors report
{{baseUrl}}/companies/:companyId/reports/agedCreditor
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/reports/agedCreditor");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/reports/agedCreditor")require "http/client"
url = "{{baseUrl}}/companies/:companyId/reports/agedCreditor"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/reports/agedCreditor"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/reports/agedCreditor");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/reports/agedCreditor"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/reports/agedCreditor HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/reports/agedCreditor")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/reports/agedCreditor"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/reports/agedCreditor")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/reports/agedCreditor")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/reports/agedCreditor');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedCreditor'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/reports/agedCreditor';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/reports/agedCreditor',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/reports/agedCreditor")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/reports/agedCreditor',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedCreditor'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/reports/agedCreditor');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedCreditor'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/reports/agedCreditor';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/reports/agedCreditor"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/reports/agedCreditor" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/reports/agedCreditor",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/reports/agedCreditor');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/reports/agedCreditor');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/reports/agedCreditor');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/reports/agedCreditor' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/reports/agedCreditor' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/reports/agedCreditor")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/reports/agedCreditor"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/reports/agedCreditor"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/reports/agedCreditor")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/reports/agedCreditor') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/reports/agedCreditor";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/reports/agedCreditorhttp GET {{baseUrl}}/companies/:companyId/reports/agedCreditorwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/reports/agedCreditorimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/reports/agedCreditor")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Aged debtors report available
{{baseUrl}}/companies/:companyId/reports/agedDebtor/available
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/reports/agedDebtor/available");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/reports/agedDebtor/available")require "http/client"
url = "{{baseUrl}}/companies/:companyId/reports/agedDebtor/available"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/reports/agedDebtor/available"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/reports/agedDebtor/available");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/reports/agedDebtor/available"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/reports/agedDebtor/available HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/reports/agedDebtor/available")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/reports/agedDebtor/available"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/reports/agedDebtor/available")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/reports/agedDebtor/available")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/reports/agedDebtor/available');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedDebtor/available'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/reports/agedDebtor/available';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/reports/agedDebtor/available',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/reports/agedDebtor/available")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/reports/agedDebtor/available',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedDebtor/available'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/reports/agedDebtor/available');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedDebtor/available'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/reports/agedDebtor/available';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/reports/agedDebtor/available"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/reports/agedDebtor/available" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/reports/agedDebtor/available",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/reports/agedDebtor/available');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/reports/agedDebtor/available');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/reports/agedDebtor/available');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/reports/agedDebtor/available' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/reports/agedDebtor/available' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/reports/agedDebtor/available")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/reports/agedDebtor/available"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/reports/agedDebtor/available"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/reports/agedDebtor/available")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/reports/agedDebtor/available') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/reports/agedDebtor/available";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/reports/agedDebtor/availablehttp GET {{baseUrl}}/companies/:companyId/reports/agedDebtor/availablewget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/reports/agedDebtor/availableimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/reports/agedDebtor/available")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Aged debtors report
{{baseUrl}}/companies/:companyId/reports/agedDebtor
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/reports/agedDebtor");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/reports/agedDebtor")require "http/client"
url = "{{baseUrl}}/companies/:companyId/reports/agedDebtor"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/reports/agedDebtor"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/reports/agedDebtor");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/reports/agedDebtor"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/reports/agedDebtor HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/reports/agedDebtor")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/reports/agedDebtor"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/reports/agedDebtor")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/reports/agedDebtor")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/reports/agedDebtor');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedDebtor'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/reports/agedDebtor';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/reports/agedDebtor',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/reports/agedDebtor")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/reports/agedDebtor',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedDebtor'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/reports/agedDebtor');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/reports/agedDebtor'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/reports/agedDebtor';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/reports/agedDebtor"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/reports/agedDebtor" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/reports/agedDebtor",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/reports/agedDebtor');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/reports/agedDebtor');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/reports/agedDebtor');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/reports/agedDebtor' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/reports/agedDebtor' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/reports/agedDebtor")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/reports/agedDebtor"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/reports/agedDebtor"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/reports/agedDebtor")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/reports/agedDebtor') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/reports/agedDebtor";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/reports/agedDebtorhttp GET {{baseUrl}}/companies/:companyId/reports/agedDebtorwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/reports/agedDebtorimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/reports/agedDebtor")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get sales order
{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId
QUERY PARAMS
salesOrderId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/salesOrders/:salesOrderId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/salesOrders/:salesOrderId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/salesOrders/:salesOrderId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/salesOrders/:salesOrderId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderIdhttp GET {{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/salesOrders/:salesOrderId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List sales orders
{{baseUrl}}/companies/:companyId/data/salesOrders
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/salesOrders?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/salesOrders" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/salesOrders?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/salesOrders?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/salesOrders?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/salesOrders?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/salesOrders?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/salesOrders?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/salesOrders?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/salesOrders?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/salesOrders?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/salesOrders?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/salesOrders',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/salesOrders?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/salesOrders?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/salesOrders?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/salesOrders?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/salesOrders',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/salesOrders');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/salesOrders',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/salesOrders?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/salesOrders?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/salesOrders?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/salesOrders?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/salesOrders?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/salesOrders');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/salesOrders');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/salesOrders?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/salesOrders?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/salesOrders?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/salesOrders"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/salesOrders"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/salesOrders?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/salesOrders') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/salesOrders";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/salesOrders?page='http GET '{{baseUrl}}/companies/:companyId/data/salesOrders?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/salesOrders?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/salesOrders?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create suppliers
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/suppliers HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/suppliers',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/suppliers", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/suppliers') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliersimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Download supplier attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/downloadhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/downloadwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/downloadimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create-update supplier model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/suppliers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/suppliers',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/suppliers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/suppliers') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliershttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/supplierswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliersimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/suppliers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the supplier",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a 2-letter country code",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Only the first address provided will be considered, all other entries will be not be recorded",
"field": "Addresses"
}
],
"warnings": []
}
},
"contactName": {
"description": "The name of the main contact for the supplier",
"displayName": "Contact Name",
"required": false,
"type": "String"
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the supplier",
"displayName": "Default Currency",
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred email address the supplier should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the supplier should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String"
},
"registrationNumber": {
"description": "The supplier's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only for Exact Netherlands, if provided, must be exactly 20 characters in length",
"field": "RegistrationNumber"
}
]
}
},
"supplierName": {
"description": "The name for the supplier, typically a company name",
"displayName": "Supplier Name",
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The supplier's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the supplier",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a 2-letter country code",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Only the first address provided will be considered, all other entries will be not be recorded",
"field": "Addresses"
}
],
"warnings": []
}
},
"contactName": {
"description": "The name of the main contact for the supplier",
"displayName": "Contact Name",
"required": false,
"type": "String"
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the supplier",
"displayName": "Default Currency",
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred email address the supplier should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the supplier should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String"
},
"registrationNumber": {
"description": "The supplier's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only for Exact Netherlands, if provided, must be exactly 20 characters in length",
"field": "RegistrationNumber"
}
]
}
},
"supplierName": {
"description": "The name for the supplier, typically a company name",
"displayName": "Supplier Name",
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The supplier's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the supplier",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String"
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": true,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Only one address may be specified",
"field": "Addresses"
}
],
"warnings": []
}
},
"contactName": {
"description": "The name of the main contact for the supplier",
"displayName": "Contact Name",
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred email address the supplier should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the supplier",
"displayName": "Supplier Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"supplierName": {
"description": "The name for the supplier, typically a company name",
"displayName": "Supplier Name",
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The supplier's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the supplier",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 255 characters.",
"field": "Addresses.City"
}
],
"warnings": []
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 255 characters.",
"field": "Addresses.Country"
}
],
"warnings": []
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 127 characters.",
"field": "Addresses.Line1"
}
],
"warnings": []
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 127 characters.",
"field": "Addresses.Line2"
}
],
"warnings": []
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 11 characters.",
"field": "Addresses.PostalCode"
}
],
"warnings": []
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 255 characters.",
"field": "Addresses.Region"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Array",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Addresses"
}
],
"warnings": [
{
"details": "Must only have 5 address entries at most.",
"field": "Addresses"
}
]
}
},
"emailAddress": {
"description": "The preferred email address the supplier should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 255 characters.",
"field": "EmailAddress"
}
],
"warnings": []
}
},
"phone": {
"description": "The preferred phone number the supplier should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 21 characters.",
"field": "Phone"
}
],
"warnings": []
}
},
"registrationNumber": {
"description": "The supplier's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 14 characters.",
"field": "RegistrationNumber"
}
],
"warnings": []
}
},
"status": {
"description": "The current state of the supplier",
"displayName": "Supplier Status",
"options": [
{
"required": false,
"type": "String",
"value": "Active"
},
{
"required": false,
"type": "String",
"value": "Unknown"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Status"
}
],
"warnings": []
}
},
"supplierName": {
"description": "The name for the supplier, typically a company name",
"displayName": "Supplier Name",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided and must contain a First and Last name separated by a ' '(space).",
"field": "SupplierName"
}
],
"warnings": [
{
"details": "Must not have the part after the first name longer than 30 characters.",
"field": "SupplierName"
},
{
"details": "Must not have its first part (i.e. the first name) longer than 20 characters.",
"field": "SupplierName"
}
]
}
},
"taxNumber": {
"description": "The supplier's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 19 characters.",
"field": "TaxNumber"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the supplier",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be a two letter Country ISO code",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Billing",
"required": false,
"type": "String",
"value": "Billing"
},
{
"displayName": "Delivery",
"required": false,
"type": "String",
"value": "Delivery"
},
{
"displayName": "Unknown",
"required": false,
"type": "String",
"value": "Unknown"
}
],
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Multiple addresses of Unknown type may be provided",
"field": "Addresses"
}
],
"warnings": [
{
"details": "Only one each of Billing and Delivery addresses can be provided",
"field": "Addresses"
}
]
}
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the supplier",
"displayName": "Default Currency",
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred email address the supplier should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the supplier should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the supplier",
"displayName": "Supplier Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"supplierName": {
"description": "The name for the supplier, typically a company name",
"displayName": "Supplier Name",
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The supplier's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the supplier",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 31 characters.",
"field": "Addresses.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 31 characters.",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 41 characters.",
"field": "Addresses.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 41 characters.",
"field": "Addresses.Line2"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 13 characters.",
"field": "Addresses.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 21 characters.",
"field": "Addresses.Region"
}
]
}
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Billing Address",
"required": false,
"type": "String",
"value": "Billing"
},
{
"displayName": "Delivery Address",
"required": false,
"type": "String",
"value": "Delivery"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Only 1 address each of type(s) Billing/Delivery may be specified.",
"field": "Addresses.Type"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array"
},
"contactName": {
"description": "The name of the main contact for the supplier",
"displayName": "Contact Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 25 characters for first and last names",
"field": "ContactName"
}
]
}
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the supplier",
"displayName": "Default Currency",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If not set, will default to the base currency of the QuickBooks Desktop company",
"field": "DefaultCurrency"
}
],
"warnings": [
{
"details": "Must be a three letter ISO code that matches an existing, active currency in the QuickBooks Desktop company",
"field": "DefaultCurrency"
},
{
"details": "Can only be set if Multicurrency is enabled within the QuickBooks Desktop company",
"field": "DefaultCurrency"
}
]
}
},
"emailAddress": {
"description": "The preferred email address the supplier should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the supplier should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String"
},
"registrationNumber": {
"description": "The supplier's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the supplier",
"displayName": "Supplier Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"supplierName": {
"description": "The name for the supplier, typically a company name",
"displayName": "Supplier Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 41 characters.",
"field": "SupplierName"
}
]
}
},
"taxNumber": {
"description": "The supplier's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 30 characters.",
"field": "TaxNumber"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the supplier",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 255 characters.",
"field": "Addresses.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 50 characters.",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "Addresses.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "Addresses.Line2"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only English alphabet characters are permitted.",
"field": "Addresses.PostalCode"
},
{
"details": "Max length of 50 characters.",
"field": "Addresses.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 255 characters.",
"field": "Addresses.Region"
}
]
}
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Billing Address",
"required": false,
"type": "String",
"value": "Billing"
}
],
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the supplier",
"displayName": "Default Currency",
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred email address the supplier should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the supplier should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Country, area, and number are space separated",
"field": "Phone"
}
]
}
},
"registrationNumber": {
"description": "The supplier's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the supplier",
"displayName": "Supplier Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"supplierName": {
"description": "The name for the supplier, typically a company name",
"displayName": "Supplier Name",
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The supplier's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the supplier",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 255 characters.",
"field": "Addresses.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 50 characters.",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "Addresses.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "Addresses.Line2"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only English alphabet characters are permitted.",
"field": "Addresses.PostalCode"
},
{
"details": "Max length of 50 characters.",
"field": "Addresses.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 255 characters.",
"field": "Addresses.Region"
}
]
}
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"options": [
{
"displayName": "Billing Address",
"required": false,
"type": "String",
"value": "Billing"
}
],
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the supplier",
"displayName": "Default Currency",
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred email address the supplier should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the supplier should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Country, area, and number are space separated",
"field": "Phone"
}
]
}
},
"registrationNumber": {
"description": "The supplier's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String"
},
"status": {
"description": "The current state of the supplier",
"displayName": "Supplier Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"supplierName": {
"description": "The name for the supplier, typically a company name",
"displayName": "Supplier Name",
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The supplier's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "Contact addresses for the supplier.",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The city of the supplier address.",
"displayName": "City",
"required": false,
"type": "String"
},
"line1": {
"description": "Line 1 of the supplier address.",
"displayName": "Line 1",
"required": true,
"type": "String"
},
"line2": {
"description": "Line 2 of the supplier address.",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "Post or Zip code for the address.",
"displayName": "Postal code",
"required": false,
"type": "String"
},
"region": {
"description": "The region of the supplier address.",
"displayName": "Region",
"required": false,
"type": "String"
},
"type": {
"description": "The type of address as it related to the supplier.",
"displayName": "Type",
"options": [
{
"displayName": "Unknown Address",
"required": false,
"type": "String",
"value": "Unknown"
}
],
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "If Address type is not specified, it will default to type ''Unknown''",
"field": "addresses.type"
}
],
"warnings": []
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "Only one address can be included in the Addresses array.",
"field": "addresses"
}
]
}
},
"contactName": {
"description": "The name of the main contact for the supplier.",
"displayName": "Contact Name",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "The contact name can have a maximum of 30 characters",
"field": "contactName"
}
]
}
},
"defaultCurrency": {
"description": "If not provided, the currency will default to the company's base currency.",
"displayName": "Default Currency",
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The email address that the supplier may be contacted on.",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"id": {
"description": "ID of the supplier.",
"displayName": "Id",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "The supplier ID must be all Uppercase, if it is not, it will be converted to Uppercase before pushing.",
"field": "id"
}
],
"warnings": [
{
"details": "The supplier ID must be unique, contain no spaces and have a maximum of 8 characters.",
"field": "id"
}
]
}
},
"phone": {
"description": "The telephone number that the supplier may be contacted on.",
"displayName": "Telephone",
"required": false,
"type": "String"
},
"status": {
"description": "The status of the supplier.",
"displayName": "Status",
"options": [
{
"displayName": "Active Status",
"required": false,
"type": "String",
"value": "Active"
}
],
"required": false,
"type": "String"
},
"supplierName": {
"description": "Name of the supplier.",
"displayName": "Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "The supplier name can have a maximum of 60 characters",
"field": "supplierName"
}
]
}
},
"taxNumber": {
"description": "Legal company registration identifier.",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [
{
"details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company."
}
],
"warnings": []
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the supplier",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"options": [
{
"displayName": "Afghanistan (AF)",
"required": false,
"type": "String",
"value": "Afghanistan (AF)"
},
{
"displayName": "Albania (AL)",
"required": false,
"type": "String",
"value": "Albania (AL)"
},
{
"displayName": "Algeria (DZ)",
"required": false,
"type": "String",
"value": "Algeria (DZ)"
},
{
"displayName": "Andorra (AD)",
"required": false,
"type": "String",
"value": "Andorra (AD)"
},
{
"displayName": "Angola (AO)",
"required": false,
"type": "String",
"value": "Angola (AO)"
},
{
"displayName": "Argentina (AR)",
"required": false,
"type": "String",
"value": "Argentina (AR)"
},
{
"displayName": "Armenia (AM)",
"required": false,
"type": "String",
"value": "Armenia (AM)"
},
{
"displayName": "Aruba (AW)",
"required": false,
"type": "String",
"value": "Aruba (AW)"
},
{
"displayName": "Australia (AU)",
"required": false,
"type": "String",
"value": "Australia (AU)"
},
{
"displayName": "Austria (AT)",
"required": false,
"type": "String",
"value": "Austria (AT)"
},
{
"displayName": "Azerbaijan (AZ)",
"required": false,
"type": "String",
"value": "Azerbaijan (AZ)"
},
{
"displayName": "Bahamas (BS)",
"required": false,
"type": "String",
"value": "Bahamas (BS)"
},
{
"displayName": "Bahrain (BH)",
"required": false,
"type": "String",
"value": "Bahrain (BH)"
},
{
"displayName": "Bangladesh (BD)",
"required": false,
"type": "String",
"value": "Bangladesh (BD)"
},
{
"displayName": "Barbados (BB)",
"required": false,
"type": "String",
"value": "Barbados (BB)"
},
{
"displayName": "Belarus (BY)",
"required": false,
"type": "String",
"value": "Belarus (BY)"
},
{
"displayName": "Belgium (BE)",
"required": false,
"type": "String",
"value": "Belgium (BE)"
},
{
"displayName": "Belize (BZ)",
"required": false,
"type": "String",
"value": "Belize (BZ)"
},
{
"displayName": "Benin (BJ)",
"required": false,
"type": "String",
"value": "Benin (BJ)"
},
{
"displayName": "Bermuda (BM)",
"required": false,
"type": "String",
"value": "Bermuda (BM)"
},
{
"displayName": "Bhutan (BT)",
"required": false,
"type": "String",
"value": "Bhutan (BT)"
},
{
"displayName": "Bolivia (BO)",
"required": false,
"type": "String",
"value": "Bolivia (BO)"
},
{
"displayName": "Bosnia and Herzegovina (BA)",
"required": false,
"type": "String",
"value": "Bosnia and Herzegovina (BA)"
},
{
"displayName": "Botswana (BW)",
"required": false,
"type": "String",
"value": "Botswana (BW)"
},
{
"displayName": "Brazil (BR)",
"required": false,
"type": "String",
"value": "Brazil (BR)"
},
{
"displayName": "British Virgin Islands (VG)",
"required": false,
"type": "String",
"value": "British Virgin Islands (VG)"
},
{
"displayName": "Brunei Darussalam (BN)",
"required": false,
"type": "String",
"value": "Brunei Darussalam (BN)"
},
{
"displayName": "Bulgaria (BG)",
"required": false,
"type": "String",
"value": "Bulgaria (BG)"
},
{
"displayName": "Burkina Faso (BF)",
"required": false,
"type": "String",
"value": "Burkina Faso (BF)"
},
{
"displayName": "Burundi (BI)",
"required": false,
"type": "String",
"value": "Burundi (BI)"
},
{
"displayName": "Cambodia (KH)",
"required": false,
"type": "String",
"value": "Cambodia (KH)"
},
{
"displayName": "Cameroon (CM)",
"required": false,
"type": "String",
"value": "Cameroon (CM)"
},
{
"displayName": "Canada (CA)",
"required": false,
"type": "String",
"value": "Canada (CA)"
},
{
"displayName": "Cape Verde (CV)",
"required": false,
"type": "String",
"value": "Cape Verde (CV)"
},
{
"displayName": "Cayman Islands (KY)",
"required": false,
"type": "String",
"value": "Cayman Islands (KY)"
},
{
"displayName": "Central African Republic (CF)",
"required": false,
"type": "String",
"value": "Central African Republic (CF)"
},
{
"displayName": "Chad (TD)",
"required": false,
"type": "String",
"value": "Chad (TD)"
},
{
"displayName": "Chile (CL)",
"required": false,
"type": "String",
"value": "Chile (CL)"
},
{
"displayName": "China (CN)",
"required": false,
"type": "String",
"value": "China (CN)"
},
{
"displayName": "Colombia (CO)",
"required": false,
"type": "String",
"value": "Colombia (CO)"
},
{
"displayName": "Comoros (KM)",
"required": false,
"type": "String",
"value": "Comoros (KM)"
},
{
"displayName": "Congo (CG)",
"required": false,
"type": "String",
"value": "Congo (CG)"
},
{
"displayName": "Costa Rica (CR)",
"required": false,
"type": "String",
"value": "Costa Rica (CR)"
},
{
"displayName": "Croatia (HR)",
"required": false,
"type": "String",
"value": "Croatia (HR)"
},
{
"displayName": "Cuba (CU)",
"required": false,
"type": "String",
"value": "Cuba (CU)"
},
{
"displayName": "Cura�ao (CW)",
"required": false,
"type": "String",
"value": "Cura�ao (CW)"
},
{
"displayName": "Cyprus (CY)",
"required": false,
"type": "String",
"value": "Cyprus (CY)"
},
{
"displayName": "Czech Republic (CZ)",
"required": false,
"type": "String",
"value": "Czech Republic (CZ)"
},
{
"displayName": "Democratic Republic of the Congo (CD)",
"required": false,
"type": "String",
"value": "Democratic Republic of the Congo (CD)"
},
{
"displayName": "Denmark (DK)",
"required": false,
"type": "String",
"value": "Denmark (DK)"
},
{
"displayName": "Djibouti (DJ)",
"required": false,
"type": "String",
"value": "Djibouti (DJ)"
},
{
"displayName": "Dominica (DM)",
"required": false,
"type": "String",
"value": "Dominica (DM)"
},
{
"displayName": "Dominican Republic (DO)",
"required": false,
"type": "String",
"value": "Dominican Republic (DO)"
},
{
"displayName": "East Timor (TP)",
"required": false,
"type": "String",
"value": "East Timor (TP)"
},
{
"displayName": "Ecuador (EC)",
"required": false,
"type": "String",
"value": "Ecuador (EC)"
},
{
"displayName": "Egypt (EG)",
"required": false,
"type": "String",
"value": "Egypt (EG)"
},
{
"displayName": "El Salvador (SV)",
"required": false,
"type": "String",
"value": "El Salvador (SV)"
},
{
"displayName": "Equatorial Guinea (GQ)",
"required": false,
"type": "String",
"value": "Equatorial Guinea (GQ)"
},
{
"displayName": "Eritrea (ER)",
"required": false,
"type": "String",
"value": "Eritrea (ER)"
},
{
"displayName": "Estonia (EE)",
"required": false,
"type": "String",
"value": "Estonia (EE)"
},
{
"displayName": "Ethiopia (ET)",
"required": false,
"type": "String",
"value": "Ethiopia (ET)"
},
{
"displayName": "Falkland Islands (Malvinas) (FK)",
"required": false,
"type": "String",
"value": "Falkland Islands (Malvinas) (FK)"
},
{
"displayName": "Federated States of Micronesia (FM)",
"required": false,
"type": "String",
"value": "Federated States of Micronesia (FM)"
},
{
"displayName": "Fiji (FJ)",
"required": false,
"type": "String",
"value": "Fiji (FJ)"
},
{
"displayName": "Finland (FI)",
"required": false,
"type": "String",
"value": "Finland (FI)"
},
{
"displayName": "France (FR)",
"required": false,
"type": "String",
"value": "France (FR)"
},
{
"displayName": "French Polynesia (PF)",
"required": false,
"type": "String",
"value": "French Polynesia (PF)"
},
{
"displayName": "Gabon (GA)",
"required": false,
"type": "String",
"value": "Gabon (GA)"
},
{
"displayName": "Gambia (GM)",
"required": false,
"type": "String",
"value": "Gambia (GM)"
},
{
"displayName": "Georgia (GE)",
"required": false,
"type": "String",
"value": "Georgia (GE)"
},
{
"displayName": "Germany (DE)",
"required": false,
"type": "String",
"value": "Germany (DE)"
},
{
"displayName": "Ghana (GH)",
"required": false,
"type": "String",
"value": "Ghana (GH)"
},
{
"displayName": "Gibraltar (GI)",
"required": false,
"type": "String",
"value": "Gibraltar (GI)"
},
{
"displayName": "Greece (GR)",
"required": false,
"type": "String",
"value": "Greece (GR)"
},
{
"displayName": "Greenland (GL)",
"required": false,
"type": "String",
"value": "Greenland (GL)"
},
{
"displayName": "Grenada (GD)",
"required": false,
"type": "String",
"value": "Grenada (GD)"
},
{
"displayName": "Guadaloupe (GP)",
"required": false,
"type": "String",
"value": "Guadaloupe (GP)"
},
{
"displayName": "Guam (GU)",
"required": false,
"type": "String",
"value": "Guam (GU)"
},
{
"displayName": "Guatemala (GT)",
"required": false,
"type": "String",
"value": "Guatemala (GT)"
},
{
"displayName": "Guernsey (GG)",
"required": false,
"type": "String",
"value": "Guernsey (GG)"
},
{
"displayName": "Guinea (GN)",
"required": false,
"type": "String",
"value": "Guinea (GN)"
},
{
"displayName": "Guinea-Bissau (GW)",
"required": false,
"type": "String",
"value": "Guinea-Bissau (GW)"
},
{
"displayName": "Guyana (GY)",
"required": false,
"type": "String",
"value": "Guyana (GY)"
},
{
"displayName": "Haiti (HT)",
"required": false,
"type": "String",
"value": "Haiti (HT)"
},
{
"displayName": "Honduras (HN)",
"required": false,
"type": "String",
"value": "Honduras (HN)"
},
{
"displayName": "Hong Kong (HK)",
"required": false,
"type": "String",
"value": "Hong Kong (HK)"
},
{
"displayName": "Hungary (HU)",
"required": false,
"type": "String",
"value": "Hungary (HU)"
},
{
"displayName": "Iceland (IS)",
"required": false,
"type": "String",
"value": "Iceland (IS)"
},
{
"displayName": "India (IN)",
"required": false,
"type": "String",
"value": "India (IN)"
},
{
"displayName": "Indonesia (ID)",
"required": false,
"type": "String",
"value": "Indonesia (ID)"
},
{
"displayName": "Iran (IR)",
"required": false,
"type": "String",
"value": "Iran (IR)"
},
{
"displayName": "Iraq (IQ)",
"required": false,
"type": "String",
"value": "Iraq (IQ)"
},
{
"displayName": "Ireland (IE)",
"required": false,
"type": "String",
"value": "Ireland (IE)"
},
{
"displayName": "Israel (IL)",
"required": false,
"type": "String",
"value": "Israel (IL)"
},
{
"displayName": "Italy (IT)",
"required": false,
"type": "String",
"value": "Italy (IT)"
},
{
"displayName": "Ivory Coast (CI)",
"required": false,
"type": "String",
"value": "Ivory Coast (CI)"
},
{
"displayName": "Jamaica (JM)",
"required": false,
"type": "String",
"value": "Jamaica (JM)"
},
{
"displayName": "Japan (JP)",
"required": false,
"type": "String",
"value": "Japan (JP)"
},
{
"displayName": "Jersey (JE)",
"required": false,
"type": "String",
"value": "Jersey (JE)"
},
{
"displayName": "Jordan (JO)",
"required": false,
"type": "String",
"value": "Jordan (JO)"
},
{
"displayName": "Kazakhstan (KZ)",
"required": false,
"type": "String",
"value": "Kazakhstan (KZ)"
},
{
"displayName": "Kenya (KE)",
"required": false,
"type": "String",
"value": "Kenya (KE)"
},
{
"displayName": "Kuwait (KW)",
"required": false,
"type": "String",
"value": "Kuwait (KW)"
},
{
"displayName": "Kyrgyzstan (KG)",
"required": false,
"type": "String",
"value": "Kyrgyzstan (KG)"
},
{
"displayName": "Laos (LA)",
"required": false,
"type": "String",
"value": "Laos (LA)"
},
{
"displayName": "Latvia (LV)",
"required": false,
"type": "String",
"value": "Latvia (LV)"
},
{
"displayName": "Lebanon (LB)",
"required": false,
"type": "String",
"value": "Lebanon (LB)"
},
{
"displayName": "Lesotho (LS)",
"required": false,
"type": "String",
"value": "Lesotho (LS)"
},
{
"displayName": "Liberia (LR)",
"required": false,
"type": "String",
"value": "Liberia (LR)"
},
{
"displayName": "Libya (LY)",
"required": false,
"type": "String",
"value": "Libya (LY)"
},
{
"displayName": "Liechtenstein (LI)",
"required": false,
"type": "String",
"value": "Liechtenstein (LI)"
},
{
"displayName": "Lithuania (LT)",
"required": false,
"type": "String",
"value": "Lithuania (LT)"
},
{
"displayName": "Luxembourg (LU)",
"required": false,
"type": "String",
"value": "Luxembourg (LU)"
},
{
"displayName": "Macau (MO)",
"required": false,
"type": "String",
"value": "Macau (MO)"
},
{
"displayName": "Macedonia (MK)",
"required": false,
"type": "String",
"value": "Macedonia (MK)"
},
{
"displayName": "Madagascar (MG)",
"required": false,
"type": "String",
"value": "Madagascar (MG)"
},
{
"displayName": "Malawi (MW)",
"required": false,
"type": "String",
"value": "Malawi (MW)"
},
{
"displayName": "Malaysia (MY)",
"required": false,
"type": "String",
"value": "Malaysia (MY)"
},
{
"displayName": "Maldives (MV)",
"required": false,
"type": "String",
"value": "Maldives (MV)"
},
{
"displayName": "Mali (ML)",
"required": false,
"type": "String",
"value": "Mali (ML)"
},
{
"displayName": "Malta (MT)",
"required": false,
"type": "String",
"value": "Malta (MT)"
},
{
"displayName": "Mauritania (MR)",
"required": false,
"type": "String",
"value": "Mauritania (MR)"
},
{
"displayName": "Mauritius (MU)",
"required": false,
"type": "String",
"value": "Mauritius (MU)"
},
{
"displayName": "Mexico (MX)",
"required": false,
"type": "String",
"value": "Mexico (MX)"
},
{
"displayName": "Moldova (MD)",
"required": false,
"type": "String",
"value": "Moldova (MD)"
},
{
"displayName": "Monaco (MC)",
"required": false,
"type": "String",
"value": "Monaco (MC)"
},
{
"displayName": "Mongolia (MN)",
"required": false,
"type": "String",
"value": "Mongolia (MN)"
},
{
"displayName": "Montenegro (ME)",
"required": false,
"type": "String",
"value": "Montenegro (ME)"
},
{
"displayName": "Morocco (MA)",
"required": false,
"type": "String",
"value": "Morocco (MA)"
},
{
"displayName": "Mozambique (MZ)",
"required": false,
"type": "String",
"value": "Mozambique (MZ)"
},
{
"displayName": "Myanmar (MM)",
"required": false,
"type": "String",
"value": "Myanmar (MM)"
},
{
"displayName": "Namibia (NA)",
"required": false,
"type": "String",
"value": "Namibia (NA)"
},
{
"displayName": "Nepal (NP)",
"required": false,
"type": "String",
"value": "Nepal (NP)"
},
{
"displayName": "Netherlands (NL)",
"required": false,
"type": "String",
"value": "Netherlands (NL)"
},
{
"displayName": "Netherlands Antilles (AN)",
"required": false,
"type": "String",
"value": "Netherlands Antilles (AN)"
},
{
"displayName": "New Caledonia (NC)",
"required": false,
"type": "String",
"value": "New Caledonia (NC)"
},
{
"displayName": "New Zealand (NZ)",
"required": false,
"type": "String",
"value": "New Zealand (NZ)"
},
{
"displayName": "Nicaragua (NI)",
"required": false,
"type": "String",
"value": "Nicaragua (NI)"
},
{
"displayName": "Niger (NE)",
"required": false,
"type": "String",
"value": "Niger (NE)"
},
{
"displayName": "Nigeria (NG)",
"required": false,
"type": "String",
"value": "Nigeria (NG)"
},
{
"displayName": "North Korea (KP)",
"required": false,
"type": "String",
"value": "North Korea (KP)"
},
{
"displayName": "Norway (NO)",
"required": false,
"type": "String",
"value": "Norway (NO)"
},
{
"displayName": "Oman (OM)",
"required": false,
"type": "String",
"value": "Oman (OM)"
},
{
"displayName": "Pakistan (PK)",
"required": false,
"type": "String",
"value": "Pakistan (PK)"
},
{
"displayName": "Panama (PA)",
"required": false,
"type": "String",
"value": "Panama (PA)"
},
{
"displayName": "Papua New Guinea (PG)",
"required": false,
"type": "String",
"value": "Papua New Guinea (PG)"
},
{
"displayName": "Paraguay (PY)",
"required": false,
"type": "String",
"value": "Paraguay (PY)"
},
{
"displayName": "Peru (PE)",
"required": false,
"type": "String",
"value": "Peru (PE)"
},
{
"displayName": "Philippines (PH)",
"required": false,
"type": "String",
"value": "Philippines (PH)"
},
{
"displayName": "Poland (PL)",
"required": false,
"type": "String",
"value": "Poland (PL)"
},
{
"displayName": "Portugal (PT)",
"required": false,
"type": "String",
"value": "Portugal (PT)"
},
{
"displayName": "Puerto Rico (PR)",
"required": false,
"type": "String",
"value": "Puerto Rico (PR)"
},
{
"displayName": "Qatar (QA)",
"required": false,
"type": "String",
"value": "Qatar (QA)"
},
{
"displayName": "Romania (RO)",
"required": false,
"type": "String",
"value": "Romania (RO)"
},
{
"displayName": "Russia (RU)",
"required": false,
"type": "String",
"value": "Russia (RU)"
},
{
"displayName": "Rwanda (RW)",
"required": false,
"type": "String",
"value": "Rwanda (RW)"
},
{
"displayName": "Saint Kitts and Nevis (KN)",
"required": false,
"type": "String",
"value": "Saint Kitts and Nevis (KN)"
},
{
"displayName": "Saint Pierre and Miquelon (PM)",
"required": false,
"type": "String",
"value": "Saint Pierre and Miquelon (PM)"
},
{
"displayName": "Samoa (WS)",
"required": false,
"type": "String",
"value": "Samoa (WS)"
},
{
"displayName": "San Marino (SM)",
"required": false,
"type": "String",
"value": "San Marino (SM)"
},
{
"displayName": "Sao Tome and Principe (ST)",
"required": false,
"type": "String",
"value": "Sao Tome and Principe (ST)"
},
{
"displayName": "Saudi Arabia (SA)",
"required": false,
"type": "String",
"value": "Saudi Arabia (SA)"
},
{
"displayName": "Senegal (SN)",
"required": false,
"type": "String",
"value": "Senegal (SN)"
},
{
"displayName": "Serbia (RS)",
"required": false,
"type": "String",
"value": "Serbia (RS)"
},
{
"displayName": "Seychelles (SC)",
"required": false,
"type": "String",
"value": "Seychelles (SC)"
},
{
"displayName": "Sierra Leone (SL)",
"required": false,
"type": "String",
"value": "Sierra Leone (SL)"
},
{
"displayName": "Singapore (SG)",
"required": false,
"type": "String",
"value": "Singapore (SG)"
},
{
"displayName": "Slovakia (SK)",
"required": false,
"type": "String",
"value": "Slovakia (SK)"
},
{
"displayName": "Slovenia (SI)",
"required": false,
"type": "String",
"value": "Slovenia (SI)"
},
{
"displayName": "Solomon Islands (SB)",
"required": false,
"type": "String",
"value": "Solomon Islands (SB)"
},
{
"displayName": "Somalia (SO)",
"required": false,
"type": "String",
"value": "Somalia (SO)"
},
{
"displayName": "South Africa (ZA)",
"required": false,
"type": "String",
"value": "South Africa (ZA)"
},
{
"displayName": "South Korea (KR)",
"required": false,
"type": "String",
"value": "South Korea (KR)"
},
{
"displayName": "Spain (ES)",
"required": false,
"type": "String",
"value": "Spain (ES)"
},
{
"displayName": "Sri Lanka (LK)",
"required": false,
"type": "String",
"value": "Sri Lanka (LK)"
},
{
"displayName": "St. Lucia (LC)",
"required": false,
"type": "String",
"value": "St. Lucia (LC)"
},
{
"displayName": "Sudan (SD)",
"required": false,
"type": "String",
"value": "Sudan (SD)"
},
{
"displayName": "Surinam (SR)",
"required": false,
"type": "String",
"value": "Surinam (SR)"
},
{
"displayName": "Swaziland (SZ)",
"required": false,
"type": "String",
"value": "Swaziland (SZ)"
},
{
"displayName": "Sweden (SE)",
"required": false,
"type": "String",
"value": "Sweden (SE)"
},
{
"displayName": "Switzerland (CH)",
"required": false,
"type": "String",
"value": "Switzerland (CH)"
},
{
"displayName": "Syria (SY)",
"required": false,
"type": "String",
"value": "Syria (SY)"
},
{
"displayName": "Taiwan (TW)",
"required": false,
"type": "String",
"value": "Taiwan (TW)"
},
{
"displayName": "Tajikistan (TJ)",
"required": false,
"type": "String",
"value": "Tajikistan (TJ)"
},
{
"displayName": "Tanzania (TZ)",
"required": false,
"type": "String",
"value": "Tanzania (TZ)"
},
{
"displayName": "Thailand (TH)",
"required": false,
"type": "String",
"value": "Thailand (TH)"
},
{
"displayName": "Togo (TG)",
"required": false,
"type": "String",
"value": "Togo (TG)"
},
{
"displayName": "Tonga (TO)",
"required": false,
"type": "String",
"value": "Tonga (TO)"
},
{
"displayName": "Trinidad and Tobago (TT)",
"required": false,
"type": "String",
"value": "Trinidad and Tobago (TT)"
},
{
"displayName": "Tunisia (TN)",
"required": false,
"type": "String",
"value": "Tunisia (TN)"
},
{
"displayName": "Turkey (TR)",
"required": false,
"type": "String",
"value": "Turkey (TR)"
},
{
"displayName": "Turkmenistan (TM)",
"required": false,
"type": "String",
"value": "Turkmenistan (TM)"
},
{
"displayName": "Tuvalu (TV)",
"required": false,
"type": "String",
"value": "Tuvalu (TV)"
},
{
"displayName": "Uganda (UG)",
"required": false,
"type": "String",
"value": "Uganda (UG)"
},
{
"displayName": "Ukraine (UA)",
"required": false,
"type": "String",
"value": "Ukraine (UA)"
},
{
"displayName": "United Arab Emirates (AE)",
"required": false,
"type": "String",
"value": "United Arab Emirates (AE)"
},
{
"displayName": "United Kingdom (GB)",
"required": false,
"type": "String",
"value": "United Kingdom (GB)"
},
{
"displayName": "United States (US)",
"required": false,
"type": "String",
"value": "United States (US)"
},
{
"displayName": "Uruguay (UY)",
"required": false,
"type": "String",
"value": "Uruguay (UY)"
},
{
"displayName": "Uzbekistan (UZ)",
"required": false,
"type": "String",
"value": "Uzbekistan (UZ)"
},
{
"displayName": "Vanuatu (VU)",
"required": false,
"type": "String",
"value": "Vanuatu (VU)"
},
{
"displayName": "Venezuela (VE)",
"required": false,
"type": "String",
"value": "Venezuela (VE)"
},
{
"displayName": "Vietnam (VN)",
"required": false,
"type": "String",
"value": "Vietnam (VN)"
},
{
"displayName": "Virgin Islands U.S. (VI)",
"required": false,
"type": "String",
"value": "Virgin Islands U.S. (VI)"
},
{
"displayName": "Western Sahara (EH)",
"required": false,
"type": "String",
"value": "Western Sahara (EH)"
},
{
"displayName": "Yemen (YE)",
"required": false,
"type": "String",
"value": "Yemen (YE)"
},
{
"displayName": "Zaire (ZR)",
"required": false,
"type": "String",
"value": "Zaire (ZR)"
},
{
"displayName": "Zambia (ZM)",
"required": false,
"type": "String",
"value": "Zambia (ZM)"
},
{
"displayName": "Zimbabwe (ZW)",
"required": false,
"type": "String",
"value": "Zimbabwe (ZW)"
}
],
"required": false,
"type": "String"
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "If you're adding an address for this Supplier, you must also include the first line",
"field": "Addresses.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array",
"validation": {
"information": [
{
"details": "Can contain a maximum of one address",
"field": "Addresses"
}
],
"warnings": []
}
},
"contactName": {
"description": "The name of the main contact for the supplier",
"displayName": "Contact Name",
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred email address the supplier should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String"
},
"phone": {
"description": "The preferred phone number the supplier should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String"
},
"supplierName": {
"description": "The name for the supplier, typically a company name",
"displayName": "Supplier Name",
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The supplier's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the supplier",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 80 characters",
"field": "Addresses.City"
}
]
}
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"options": [
{
"displayName": "United States",
"required": false,
"type": "String",
"value": "United States"
},
{
"displayName": "Afghanistan",
"required": false,
"type": "String",
"value": "Afghanistan"
},
{
"displayName": "Aland Islands",
"required": false,
"type": "String",
"value": "Aland Islands"
},
{
"displayName": "Albania",
"required": false,
"type": "String",
"value": "Albania"
},
{
"displayName": "Algeria",
"required": false,
"type": "String",
"value": "Algeria"
},
{
"displayName": "American Samoa",
"required": false,
"type": "String",
"value": "American Samoa"
},
{
"displayName": "Andorra",
"required": false,
"type": "String",
"value": "Andorra"
},
{
"displayName": "Angola",
"required": false,
"type": "String",
"value": "Angola"
},
{
"displayName": "Anguilla",
"required": false,
"type": "String",
"value": "Anguilla"
},
{
"displayName": "Antarctica",
"required": false,
"type": "String",
"value": "Antarctica"
},
{
"displayName": "Antigua and Barbuda",
"required": false,
"type": "String",
"value": "Antigua and Barbuda"
},
{
"displayName": "Argentina",
"required": false,
"type": "String",
"value": "Argentina"
},
{
"displayName": "Armenia",
"required": false,
"type": "String",
"value": "Armenia"
},
{
"displayName": "Aruba",
"required": false,
"type": "String",
"value": "Aruba"
},
{
"displayName": "Australia",
"required": false,
"type": "String",
"value": "Australia"
},
{
"displayName": "Austria",
"required": false,
"type": "String",
"value": "Austria"
},
{
"displayName": "Azerbaijan",
"required": false,
"type": "String",
"value": "Azerbaijan"
},
{
"displayName": "Bahamas",
"required": false,
"type": "String",
"value": "Bahamas"
},
{
"displayName": "Bahrain",
"required": false,
"type": "String",
"value": "Bahrain"
},
{
"displayName": "Bangladesh",
"required": false,
"type": "String",
"value": "Bangladesh"
},
{
"displayName": "Barbados",
"required": false,
"type": "String",
"value": "Barbados"
},
{
"displayName": "Belarus",
"required": false,
"type": "String",
"value": "Belarus"
},
{
"displayName": "Belgium",
"required": false,
"type": "String",
"value": "Belgium"
},
{
"displayName": "Belize",
"required": false,
"type": "String",
"value": "Belize"
},
{
"displayName": "Benin",
"required": false,
"type": "String",
"value": "Benin"
},
{
"displayName": "Bermuda",
"required": false,
"type": "String",
"value": "Bermuda"
},
{
"displayName": "Bhutan",
"required": false,
"type": "String",
"value": "Bhutan"
},
{
"displayName": "Bolivia",
"required": false,
"type": "String",
"value": "Bolivia"
},
{
"displayName": "Bonaire, Sint Eustatius and Saba",
"required": false,
"type": "String",
"value": "Bonaire, Sint Eustatius and Saba"
},
{
"displayName": "Bosnia and Herzegovina",
"required": false,
"type": "String",
"value": "Bosnia and Herzegovina"
},
{
"displayName": "Botswana",
"required": false,
"type": "String",
"value": "Botswana"
},
{
"displayName": "Bouvet Island",
"required": false,
"type": "String",
"value": "Bouvet Island"
},
{
"displayName": "Brazil",
"required": false,
"type": "String",
"value": "Brazil"
},
{
"displayName": "British Indian Ocean Territory",
"required": false,
"type": "String",
"value": "British Indian Ocean Territory"
},
{
"displayName": "Brunei Darussalam",
"required": false,
"type": "String",
"value": "Brunei Darussalam"
},
{
"displayName": "Bulgaria",
"required": false,
"type": "String",
"value": "Bulgaria"
},
{
"displayName": "Burkina Faso",
"required": false,
"type": "String",
"value": "Burkina Faso"
},
{
"displayName": "Burundi",
"required": false,
"type": "String",
"value": "Burundi"
},
{
"displayName": "Cambodia",
"required": false,
"type": "String",
"value": "Cambodia"
},
{
"displayName": "Cameroon",
"required": false,
"type": "String",
"value": "Cameroon"
},
{
"displayName": "Canada",
"required": false,
"type": "String",
"value": "Canada"
},
{
"displayName": "Cape Verde",
"required": false,
"type": "String",
"value": "Cape Verde"
},
{
"displayName": "Cayman Islands",
"required": false,
"type": "String",
"value": "Cayman Islands"
},
{
"displayName": "Central African Republic",
"required": false,
"type": "String",
"value": "Central African Republic"
},
{
"displayName": "Chad",
"required": false,
"type": "String",
"value": "Chad"
},
{
"displayName": "Chile",
"required": false,
"type": "String",
"value": "Chile"
},
{
"displayName": "China",
"required": false,
"type": "String",
"value": "China"
},
{
"displayName": "Christmas Island",
"required": false,
"type": "String",
"value": "Christmas Island"
},
{
"displayName": "Cocos (Keeling) Islands",
"required": false,
"type": "String",
"value": "Cocos (Keeling) Islands"
},
{
"displayName": "Colombia",
"required": false,
"type": "String",
"value": "Colombia"
},
{
"displayName": "Comoros",
"required": false,
"type": "String",
"value": "Comoros"
},
{
"displayName": "Congo",
"required": false,
"type": "String",
"value": "Congo"
},
{
"displayName": "Congo, Democratic Republic",
"required": false,
"type": "String",
"value": "Congo, Democratic Republic"
},
{
"displayName": "Cook Islands",
"required": false,
"type": "String",
"value": "Cook Islands"
},
{
"displayName": "Costa Rica",
"required": false,
"type": "String",
"value": "Costa Rica"
},
{
"displayName": "C�te d'Ivoire",
"required": false,
"type": "String",
"value": "C�te d'Ivoire"
},
{
"displayName": "Croatia",
"required": false,
"type": "String",
"value": "Croatia"
},
{
"displayName": "Cuba",
"required": false,
"type": "String",
"value": "Cuba"
},
{
"displayName": "Cura�ao",
"required": false,
"type": "String",
"value": "Cura�ao"
},
{
"displayName": "Cyprus",
"required": false,
"type": "String",
"value": "Cyprus"
},
{
"displayName": "Czech Republic",
"required": false,
"type": "String",
"value": "Czech Republic"
},
{
"displayName": "Denmark",
"required": false,
"type": "String",
"value": "Denmark"
},
{
"displayName": "Djibouti",
"required": false,
"type": "String",
"value": "Djibouti"
},
{
"displayName": "Dominica",
"required": false,
"type": "String",
"value": "Dominica"
},
{
"displayName": "Dominican Republic",
"required": false,
"type": "String",
"value": "Dominican Republic"
},
{
"displayName": "Ecuador",
"required": false,
"type": "String",
"value": "Ecuador"
},
{
"displayName": "Egypt",
"required": false,
"type": "String",
"value": "Egypt"
},
{
"displayName": "El Salvador",
"required": false,
"type": "String",
"value": "El Salvador"
},
{
"displayName": "Equatorial Guinea",
"required": false,
"type": "String",
"value": "Equatorial Guinea"
},
{
"displayName": "Eritrea",
"required": false,
"type": "String",
"value": "Eritrea"
},
{
"displayName": "Estonia",
"required": false,
"type": "String",
"value": "Estonia"
},
{
"displayName": "Eswatini",
"required": false,
"type": "String",
"value": "Eswatini"
},
{
"displayName": "Ethiopia",
"required": false,
"type": "String",
"value": "Ethiopia"
},
{
"displayName": "Falkland Islands (Malvinas",
"required": false,
"type": "String",
"value": "Falkland Islands (Malvinas"
},
{
"displayName": "Faroe Islands",
"required": false,
"type": "String",
"value": "Faroe Islands"
},
{
"displayName": "Fiji",
"required": false,
"type": "String",
"value": "Fiji"
},
{
"displayName": "Finland",
"required": false,
"type": "String",
"value": "Finland"
},
{
"displayName": "France",
"required": false,
"type": "String",
"value": "France"
},
{
"displayName": "French Guiana",
"required": false,
"type": "String",
"value": "French Guiana"
},
{
"displayName": "French Polynesia",
"required": false,
"type": "String",
"value": "French Polynesia"
},
{
"displayName": "French Southern Territories",
"required": false,
"type": "String",
"value": "French Southern Territories"
},
{
"displayName": "Gabon",
"required": false,
"type": "String",
"value": "Gabon"
},
{
"displayName": "Gambia",
"required": false,
"type": "String",
"value": "Gambia"
},
{
"displayName": "Georgia",
"required": false,
"type": "String",
"value": "Georgia"
},
{
"displayName": "Germany",
"required": false,
"type": "String",
"value": "Germany"
},
{
"displayName": "Ghana",
"required": false,
"type": "String",
"value": "Ghana"
},
{
"displayName": "Gibraltar",
"required": false,
"type": "String",
"value": "Gibraltar"
},
{
"displayName": "Greece",
"required": false,
"type": "String",
"value": "Greece"
},
{
"displayName": "Greenland",
"required": false,
"type": "String",
"value": "Greenland"
},
{
"displayName": "Grenada",
"required": false,
"type": "String",
"value": "Grenada"
},
{
"displayName": "Guadeloupe",
"required": false,
"type": "String",
"value": "Guadeloupe"
},
{
"displayName": "Guam",
"required": false,
"type": "String",
"value": "Guam"
},
{
"displayName": "Guatemala",
"required": false,
"type": "String",
"value": "Guatemala"
},
{
"displayName": "Guernsey",
"required": false,
"type": "String",
"value": "Guernsey"
},
{
"displayName": "Guinea",
"required": false,
"type": "String",
"value": "Guinea"
},
{
"displayName": "Guinea-Bissau",
"required": false,
"type": "String",
"value": "Guinea-Bissau"
},
{
"displayName": "Guyana",
"required": false,
"type": "String",
"value": "Guyana"
},
{
"displayName": "Haiti",
"required": false,
"type": "String",
"value": "Haiti"
},
{
"displayName": "Heard Is. & Mcdonald Islands",
"required": false,
"type": "String",
"value": "Heard Is. & Mcdonald Islands"
},
{
"displayName": "Honduras",
"required": false,
"type": "String",
"value": "Honduras"
},
{
"displayName": "Hong Kong",
"required": false,
"type": "String",
"value": "Hong Kong"
},
{
"displayName": "Hungary",
"required": false,
"type": "String",
"value": "Hungary"
},
{
"displayName": "Iceland",
"required": false,
"type": "String",
"value": "Iceland"
},
{
"displayName": "India",
"required": false,
"type": "String",
"value": "India"
},
{
"displayName": "Indonesia",
"required": false,
"type": "String",
"value": "Indonesia"
},
{
"displayName": "Iran, Islamic Republic of",
"required": false,
"type": "String",
"value": "Iran, Islamic Republic of"
},
{
"displayName": "Iraq",
"required": false,
"type": "String",
"value": "Iraq"
},
{
"displayName": "Ireland",
"required": false,
"type": "String",
"value": "Ireland"
},
{
"displayName": "Isle of Man",
"required": false,
"type": "String",
"value": "Isle of Man"
},
{
"displayName": "Israel",
"required": false,
"type": "String",
"value": "Israel"
},
{
"displayName": "Italy",
"required": false,
"type": "String",
"value": "Italy"
},
{
"displayName": "Jamaica",
"required": false,
"type": "String",
"value": "Jamaica"
},
{
"displayName": "Japan",
"required": false,
"type": "String",
"value": "Japan"
},
{
"displayName": "Jersey",
"required": false,
"type": "String",
"value": "Jersey"
},
{
"displayName": "Jordan",
"required": false,
"type": "String",
"value": "Jordan"
},
{
"displayName": "Kazakhstan",
"required": false,
"type": "String",
"value": "Kazakhstan"
},
{
"displayName": "Kenya",
"required": false,
"type": "String",
"value": "Kenya"
},
{
"displayName": "Kiribati",
"required": false,
"type": "String",
"value": "Kiribati"
},
{
"displayName": "Korea, Republic of",
"required": false,
"type": "String",
"value": "Korea, Republic of"
},
{
"displayName": "Korea, Demo. People's Rep",
"required": false,
"type": "String",
"value": "Korea, Demo. People's Rep"
},
{
"displayName": "Kosovo",
"required": false,
"type": "String",
"value": "Kosovo"
},
{
"displayName": "Kuwait",
"required": false,
"type": "String",
"value": "Kuwait"
},
{
"displayName": "Kyrgyzstan",
"required": false,
"type": "String",
"value": "Kyrgyzstan"
},
{
"displayName": "Lao",
"required": false,
"type": "String",
"value": "Lao"
},
{
"displayName": "Latvia",
"required": false,
"type": "String",
"value": "Latvia"
},
{
"displayName": "Lebanon",
"required": false,
"type": "String",
"value": "Lebanon"
},
{
"displayName": "Lesotho",
"required": false,
"type": "String",
"value": "Lesotho"
},
{
"displayName": "Liberia",
"required": false,
"type": "String",
"value": "Liberia"
},
{
"displayName": "Libyan Arab Jamahiriya",
"required": false,
"type": "String",
"value": "Libyan Arab Jamahiriya"
},
{
"displayName": "Liechtenstein",
"required": false,
"type": "String",
"value": "Liechtenstein"
},
{
"displayName": "Lithuania",
"required": false,
"type": "String",
"value": "Lithuania"
},
{
"displayName": "Luxembourg",
"required": false,
"type": "String",
"value": "Luxembourg"
},
{
"displayName": "Macao",
"required": false,
"type": "String",
"value": "Macao"
},
{
"displayName": "Macedonia",
"required": false,
"type": "String",
"value": "Macedonia"
},
{
"displayName": "Madagascar",
"required": false,
"type": "String",
"value": "Madagascar"
},
{
"displayName": "Malawi",
"required": false,
"type": "String",
"value": "Malawi"
},
{
"displayName": "Malaysia",
"required": false,
"type": "String",
"value": "Malaysia"
},
{
"displayName": "Maldives",
"required": false,
"type": "String",
"value": "Maldives"
},
{
"displayName": "Mali",
"required": false,
"type": "String",
"value": "Mali"
},
{
"displayName": "Malta",
"required": false,
"type": "String",
"value": "Malta"
},
{
"displayName": "Marshall Islands",
"required": false,
"type": "String",
"value": "Marshall Islands"
},
{
"displayName": "Martinique",
"required": false,
"type": "String",
"value": "Martinique"
},
{
"displayName": "Mauritania",
"required": false,
"type": "String",
"value": "Mauritania"
},
{
"displayName": "Mauritius",
"required": false,
"type": "String",
"value": "Mauritius"
},
{
"displayName": "Mayotte",
"required": false,
"type": "String",
"value": "Mayotte"
},
{
"displayName": "Mexico",
"required": false,
"type": "String",
"value": "Mexico"
},
{
"displayName": "Micronesia",
"required": false,
"type": "String",
"value": "Micronesia"
},
{
"displayName": "Moldova, Republic of",
"required": false,
"type": "String",
"value": "Moldova, Republic of"
},
{
"displayName": "Monaco",
"required": false,
"type": "String",
"value": "Monaco"
},
{
"displayName": "Mongolia",
"required": false,
"type": "String",
"value": "Mongolia"
},
{
"displayName": "Montenegro",
"required": false,
"type": "String",
"value": "Montenegro"
},
{
"displayName": "Montserrat",
"required": false,
"type": "String",
"value": "Montserrat"
},
{
"displayName": "Morocco",
"required": false,
"type": "String",
"value": "Morocco"
},
{
"displayName": "Mozambique",
"required": false,
"type": "String",
"value": "Mozambique"
},
{
"displayName": "Myanmar",
"required": false,
"type": "String",
"value": "Myanmar"
},
{
"displayName": "Namibia",
"required": false,
"type": "String",
"value": "Namibia"
},
{
"displayName": "Nauru",
"required": false,
"type": "String",
"value": "Nauru"
},
{
"displayName": "Nepal",
"required": false,
"type": "String",
"value": "Nepal"
},
{
"displayName": "Netherlands",
"required": false,
"type": "String",
"value": "Netherlands"
},
{
"displayName": "Netherlands Antilles",
"required": false,
"type": "String",
"value": "Netherlands Antilles"
},
{
"displayName": "New Caledonia",
"required": false,
"type": "String",
"value": "New Caledonia"
},
{
"displayName": "New Zealand",
"required": false,
"type": "String",
"value": "New Zealand"
},
{
"displayName": "Nicaragua",
"required": false,
"type": "String",
"value": "Nicaragua"
},
{
"displayName": "Niger",
"required": false,
"type": "String",
"value": "Niger"
},
{
"displayName": "Nigeria",
"required": false,
"type": "String",
"value": "Nigeria"
},
{
"displayName": "Niue",
"required": false,
"type": "String",
"value": "Niue"
},
{
"displayName": "Norfolk Island",
"required": false,
"type": "String",
"value": "Norfolk Island"
},
{
"displayName": "Northern Mariana Islands",
"required": false,
"type": "String",
"value": "Northern Mariana Islands"
},
{
"displayName": "Norway",
"required": false,
"type": "String",
"value": "Norway"
},
{
"displayName": "Oman",
"required": false,
"type": "String",
"value": "Oman"
},
{
"displayName": "Pakistan",
"required": false,
"type": "String",
"value": "Pakistan"
},
{
"displayName": "Palau",
"required": false,
"type": "String",
"value": "Palau"
},
{
"displayName": "Palestinian Territory, Occupied",
"required": false,
"type": "String",
"value": "Palestinian Territory, Occupied"
},
{
"displayName": "Panama",
"required": false,
"type": "String",
"value": "Panama"
},
{
"displayName": "Papua New Guinea",
"required": false,
"type": "String",
"value": "Papua New Guinea"
},
{
"displayName": "Paraguay",
"required": false,
"type": "String",
"value": "Paraguay"
},
{
"displayName": "Peru",
"required": false,
"type": "String",
"value": "Peru"
},
{
"displayName": "Philippines",
"required": false,
"type": "String",
"value": "Philippines"
},
{
"displayName": "Pitcairn",
"required": false,
"type": "String",
"value": "Pitcairn"
},
{
"displayName": "Poland",
"required": false,
"type": "String",
"value": "Poland"
},
{
"displayName": "Portugal",
"required": false,
"type": "String",
"value": "Portugal"
},
{
"displayName": "Puerto Rico",
"required": false,
"type": "String",
"value": "Puerto Rico"
},
{
"displayName": "Qatar",
"required": false,
"type": "String",
"value": "Qatar"
},
{
"displayName": "Reunion",
"required": false,
"type": "String",
"value": "Reunion"
},
{
"displayName": "Romania",
"required": false,
"type": "String",
"value": "Romania"
},
{
"displayName": "Russian Federation",
"required": false,
"type": "String",
"value": "Russian Federation"
},
{
"displayName": "Rwanda",
"required": false,
"type": "String",
"value": "Rwanda"
},
{
"displayName": "Saint Barthelemy",
"required": false,
"type": "String",
"value": "Saint Barthelemy"
},
{
"displayName": "Saint Helena",
"required": false,
"type": "String",
"value": "Saint Helena"
},
{
"displayName": "Saint Kitts and Nevis",
"required": false,
"type": "String",
"value": "Saint Kitts and Nevis"
},
{
"displayName": "Saint Lucia",
"required": false,
"type": "String",
"value": "Saint Lucia"
},
{
"displayName": "Saint Martin",
"required": false,
"type": "String",
"value": "Saint Martin"
},
{
"displayName": "Saint Pierre and Miquelon",
"required": false,
"type": "String",
"value": "Saint Pierre and Miquelon"
},
{
"displayName": "Saint Vincent and the Grenadines",
"required": false,
"type": "String",
"value": "Saint Vincent and the Grenadines"
},
{
"displayName": "Samoa",
"required": false,
"type": "String",
"value": "Samoa"
},
{
"displayName": "San Marino",
"required": false,
"type": "String",
"value": "San Marino"
},
{
"displayName": "Sao Tome and Principe",
"required": false,
"type": "String",
"value": "Sao Tome and Principe"
},
{
"displayName": "Saudi Arabia",
"required": false,
"type": "String",
"value": "Saudi Arabia"
},
{
"displayName": "Senegal",
"required": false,
"type": "String",
"value": "Senegal"
},
{
"displayName": "Serbia",
"required": false,
"type": "String",
"value": "Serbia"
},
{
"displayName": "Seychelles",
"required": false,
"type": "String",
"value": "Seychelles"
},
{
"displayName": "Sierra Leone",
"required": false,
"type": "String",
"value": "Sierra Leone"
},
{
"displayName": "Singapore",
"required": false,
"type": "String",
"value": "Singapore"
},
{
"displayName": "Sint Maarten",
"required": false,
"type": "String",
"value": "Sint Maarten"
},
{
"displayName": "Slovakia",
"required": false,
"type": "String",
"value": "Slovakia"
},
{
"displayName": "Slovenia",
"required": false,
"type": "String",
"value": "Slovenia"
},
{
"displayName": "Solomon Islands",
"required": false,
"type": "String",
"value": "Solomon Islands"
},
{
"displayName": "Somalia",
"required": false,
"type": "String",
"value": "Somalia"
},
{
"displayName": "South Africa",
"required": false,
"type": "String",
"value": "South Africa"
},
{
"displayName": "S. Georgia & S. Sandwich Is",
"required": false,
"type": "String",
"value": "S. Georgia & S. Sandwich Is"
},
{
"displayName": "Spain",
"required": false,
"type": "String",
"value": "Spain"
},
{
"displayName": "Sri Lanka",
"required": false,
"type": "String",
"value": "Sri Lanka"
},
{
"displayName": "Sudan",
"required": false,
"type": "String",
"value": "Sudan"
},
{
"displayName": "South Sudan",
"required": false,
"type": "String",
"value": "South Sudan"
},
{
"displayName": "Suriname",
"required": false,
"type": "String",
"value": "Suriname"
},
{
"displayName": "Svalbard and Jan Mayen",
"required": false,
"type": "String",
"value": "Svalbard and Jan Mayen"
},
{
"displayName": "Sweden",
"required": false,
"type": "String",
"value": "Sweden"
},
{
"displayName": "Switzerland",
"required": false,
"type": "String",
"value": "Switzerland"
},
{
"displayName": "Syrian Arab Republic",
"required": false,
"type": "String",
"value": "Syrian Arab Republic"
},
{
"displayName": "Taiwan",
"required": false,
"type": "String",
"value": "Taiwan"
},
{
"displayName": "Tajikistan",
"required": false,
"type": "String",
"value": "Tajikistan"
},
{
"displayName": "Tanzania, United Republic of",
"required": false,
"type": "String",
"value": "Tanzania, United Republic of"
},
{
"displayName": "Thailand",
"required": false,
"type": "String",
"value": "Thailand"
},
{
"displayName": "Timor-Leste",
"required": false,
"type": "String",
"value": "Timor-Leste"
},
{
"displayName": "Togo",
"required": false,
"type": "String",
"value": "Togo"
},
{
"displayName": "Tokelau",
"required": false,
"type": "String",
"value": "Tokelau"
},
{
"displayName": "Tonga",
"required": false,
"type": "String",
"value": "Tonga"
},
{
"displayName": "Trinidad and Tobago",
"required": false,
"type": "String",
"value": "Trinidad and Tobago"
},
{
"displayName": "Tunisia",
"required": false,
"type": "String",
"value": "Tunisia"
},
{
"displayName": "Turkey",
"required": false,
"type": "String",
"value": "Turkey"
},
{
"displayName": "Turkmenistan",
"required": false,
"type": "String",
"value": "Turkmenistan"
},
{
"displayName": "Turks and Caicos Islands",
"required": false,
"type": "String",
"value": "Turks and Caicos Islands"
},
{
"displayName": "Tuvalu",
"required": false,
"type": "String",
"value": "Tuvalu"
},
{
"displayName": "Uganda",
"required": false,
"type": "String",
"value": "Uganda"
},
{
"displayName": "Ukraine",
"required": false,
"type": "String",
"value": "Ukraine"
},
{
"displayName": "United Arab Emirates",
"required": false,
"type": "String",
"value": "United Arab Emirates"
},
{
"displayName": "United Kingdom",
"required": false,
"type": "String",
"value": "United Kingdom"
},
{
"displayName": "US Minor Outlying Islands",
"required": false,
"type": "String",
"value": "US Minor Outlying Islands"
},
{
"displayName": "Uruguay",
"required": false,
"type": "String",
"value": "Uruguay"
},
{
"displayName": "Uzbekistan",
"required": false,
"type": "String",
"value": "Uzbekistan"
},
{
"displayName": "Vanuatu",
"required": false,
"type": "String",
"value": "Vanuatu"
},
{
"displayName": "Vatican City State",
"required": false,
"type": "String",
"value": "Vatican City State"
},
{
"displayName": "Venezuela",
"required": false,
"type": "String",
"value": "Venezuela"
},
{
"displayName": "Vietnam",
"required": false,
"type": "String",
"value": "Vietnam"
},
{
"displayName": "Virgin Islands, British",
"required": false,
"type": "String",
"value": "Virgin Islands, British"
},
{
"displayName": "Virgin Islands, U.S",
"required": false,
"type": "String",
"value": "Virgin Islands, U.S"
},
{
"displayName": "Wallis and Futuna",
"required": false,
"type": "String",
"value": "Wallis and Futuna"
},
{
"displayName": "Western Sahara",
"required": false,
"type": "String",
"value": "Western Sahara"
},
{
"displayName": "Yemen",
"required": false,
"type": "String",
"value": "Yemen"
},
{
"displayName": "Zambia",
"required": false,
"type": "String",
"value": "Zambia"
},
{
"displayName": "Zimbabwe",
"required": false,
"type": "String",
"value": "Zimbabwe"
}
],
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Required if TaxNumber is supplied",
"field": "Addresses.Country"
}
]
}
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 200 characters",
"field": "Addresses.Line1"
}
]
}
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 200 characters",
"field": "Addresses.Line2"
}
]
}
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 30 characters",
"field": "Addresses.PostalCode"
}
]
}
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 40 characters",
"field": "Addresses.Region"
}
]
}
}
},
"required": false,
"type": "Array",
"validation": {
"information": [],
"warnings": [
{
"details": "If supplied, must contain only 1 address",
"field": "Addresses"
},
{
"details": "If TaxNumber is supplied, an Address with a Country is required",
"field": "Addresses"
}
]
}
},
"contactName": {
"description": "The name of the main contact for the supplier",
"displayName": "Contact Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be between 1 and 200 characters",
"field": "ContactName"
}
]
}
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the supplier",
"displayName": "Default Currency",
"options": [
{
"displayName": "Australian Dollar",
"required": false,
"type": "String",
"value": "AUD"
},
{
"displayName": "Canadian Dollar",
"required": false,
"type": "String",
"value": "CAD"
},
{
"displayName": "Pound Sterling",
"required": false,
"type": "String",
"value": "GBP"
},
{
"displayName": "US Dollar",
"required": false,
"type": "String",
"value": "USD"
},
{
"displayName": "Rand",
"required": false,
"type": "String",
"value": "ZAR"
}
],
"required": false,
"type": "String"
},
"emailAddress": {
"description": "The preferred email address the supplier should be contacted on",
"displayName": "Email Address",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 200 characters",
"field": "EmailAddress"
}
]
}
},
"phone": {
"description": "The preferred phone number the supplier should be contacted on",
"displayName": "Phone",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 30 characters",
"field": "Phone"
}
]
}
},
"registrationNumber": {
"description": "The supplier's registration number",
"displayName": "Registration Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 100 characters",
"field": "RegistrationNumber"
}
]
}
},
"status": {
"description": "The current state of the supplier",
"displayName": "Supplier Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Archived",
"required": false,
"type": "String",
"value": "Archived"
}
],
"required": true,
"type": "String"
},
"supplierName": {
"description": "The name for the supplier, typically a company name",
"displayName": "Supplier Name",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be between 1 and 100 characters",
"field": "SupplierName"
}
]
}
},
"taxNumber": {
"description": "The supplier's tax number",
"displayName": "Tax Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be no greater than 20 characters",
"field": "TaxNumber"
}
]
}
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "A Supplier is a person or organisation that provides a product or service",
"displayName": "Supplier",
"properties": {
"addresses": {
"description": "A collection of addresses associated to the supplier",
"displayName": "Addresses",
"properties": {
"city": {
"description": "The third line of the address, or city",
"displayName": "City",
"required": true,
"type": "String"
},
"country": {
"description": "The country for the address",
"displayName": "Country",
"required": true,
"type": "String"
},
"line1": {
"description": "The first line of the address",
"displayName": "Line 1",
"required": true,
"type": "String"
},
"line2": {
"description": "The second line of the address",
"displayName": "Line 2",
"required": true,
"type": "String"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"displayName": "Postal/Zip Code",
"required": true,
"type": "String"
},
"region": {
"description": "The fourth line of the address, or region",
"displayName": "Region",
"required": true,
"type": "String"
},
"type": {
"description": "The type of the address",
"displayName": "Address Type",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"contactName": {
"description": "The name of the main contact for the supplier",
"displayName": "Contact Name",
"required": true,
"type": "String"
},
"defaultCurrency": {
"description": "The default currency for transactions recorded against the supplier",
"displayName": "Default Currency",
"required": true,
"type": "String"
},
"emailAddress": {
"description": "The preferred email address the supplier should be contacted on",
"displayName": "Email Address",
"required": true,
"type": "String"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"phone": {
"description": "The preferred phone number the supplier should be contacted on",
"displayName": "Phone",
"required": true,
"type": "String"
},
"registrationNumber": {
"description": "The supplier's registration number",
"displayName": "Registration Number",
"required": true,
"type": "String"
},
"status": {
"description": "The current state of the supplier",
"displayName": "Supplier Status",
"required": true,
"type": "String"
},
"supplierName": {
"description": "The name for the supplier, typically a company name",
"displayName": "Supplier Name",
"required": true,
"type": "String"
},
"taxNumber": {
"description": "The supplier's tax number",
"displayName": "Tax Number",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "An accounts payable contact that supplies good or services, also referred to as a vendor.",
"displayName": "Suppliers",
"properties": {
"addresses": {
"description": "Contact addresses for the supplier.",
"displayName": "Addresses",
"properties": {
"city": {
"description": "Local city for the address.",
"displayName": "City",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 255 characters.",
"field": "addresses.city"
}
]
}
},
"country": {
"description": "Country for the address.",
"displayName": "Country",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 50 characters.",
"field": "addresses.country"
}
]
}
},
"line1": {
"description": "First line of the address.",
"displayName": "Address Line 1",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "addresses.line1"
}
]
}
},
"line2": {
"description": "Second line of the address.",
"displayName": "Address Line 2",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 500 characters.",
"field": "addresses.line2"
}
]
}
},
"postalCode": {
"description": "Post or Zip code for the address.",
"displayName": "Postal code",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Only English alphabet characters are permitted.",
"field": "addresses.postalCode"
},
{
"details": "Max length of 50 characters.",
"field": "addresses.postalCode"
}
]
}
},
"region": {
"description": "Region the address is located in.",
"displayName": "Region",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 255 characters.",
"field": "addresses.region"
}
]
}
},
"type": {
"description": "The type of address as it related to the supplier.",
"displayName": "Type",
"options": [
{
"displayName": "Billing Address",
"required": false,
"type": "String",
"value": "Billing"
},
{
"displayName": "Delivery Address",
"required": false,
"type": "String",
"value": "Delivery"
}
],
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Billing = POBOX, Delivery/Unknown = DELIVERY",
"field": "addresses.type"
}
]
}
}
},
"required": false,
"type": "Array"
},
"emailAddress": {
"description": "Main contact email for the supplier.",
"displayName": "Email",
"required": false,
"type": "String"
},
"phone": {
"description": "Main contact phone number for the supplier.",
"displayName": "Phone",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Country, area, and number are space separated",
"field": "phone"
}
]
}
},
"registrationNumber": {
"description": "Legal company registration identifier.",
"displayName": "Registration Number",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 50 characters",
"field": "registrationNumber"
}
]
}
},
"status": {
"description": "Status of the supplier account.",
"displayName": "Status",
"options": [
{
"displayName": "Active",
"required": false,
"type": "String",
"value": "Active"
},
{
"displayName": "Inactive",
"required": false,
"type": "String",
"value": "InActive"
}
],
"required": false,
"type": "String"
},
"supplierName": {
"description": "Name of the supplier.",
"displayName": "Name",
"required": true,
"type": "String"
},
"taxNumber": {
"description": "Legal tax registration identifier.",
"displayName": "Tax Number",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
}
GET
Get supplier attachment
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentIdhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get supplier
{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/suppliers/:supplierId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/suppliers/:supplierId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/suppliers/:supplierId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/suppliers/:supplierId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/suppliers/:supplierIdhttp GET {{baseUrl}}/companies/:companyId/data/suppliers/:supplierIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/suppliers/:supplierIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/suppliers/:supplierId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List supplier attachments
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachmentshttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachmentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachmentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List suppliers
{{baseUrl}}/companies/:companyId/data/suppliers
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/suppliers?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/suppliers" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/suppliers?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/suppliers?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/suppliers?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/suppliers?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/suppliers?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/suppliers?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/suppliers?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/suppliers?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/suppliers?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/suppliers?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/suppliers',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/suppliers?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/suppliers?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/suppliers?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/suppliers?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/suppliers',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/suppliers');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/suppliers',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/suppliers?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/suppliers?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/suppliers?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/suppliers?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/suppliers?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/suppliers');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/suppliers');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/suppliers?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/suppliers?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/suppliers?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/suppliers"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/suppliers"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/suppliers?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/suppliers') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/suppliers";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/suppliers?page='http GET '{{baseUrl}}/companies/:companyId/data/suppliers?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/suppliers?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/suppliers?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Update supplier
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId"
payload = {}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId"
payload <- "{}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http PUT {{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierIdimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/suppliers/:supplierId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get tax rate
{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/taxRates/:taxRateId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/taxRates/:taxRateId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/taxRates/:taxRateId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/taxRates/:taxRateId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/taxRates/:taxRateIdhttp GET {{baseUrl}}/companies/:companyId/data/taxRates/:taxRateIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/taxRates/:taxRateIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/taxRates/:taxRateId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List all tax rates
{{baseUrl}}/companies/:companyId/data/taxRates
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/taxRates?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/taxRates" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/taxRates?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/taxRates?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/taxRates?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/taxRates?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/taxRates?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/taxRates?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/taxRates?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/taxRates?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/taxRates?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/taxRates?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/taxRates',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/taxRates?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/taxRates?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/taxRates?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/taxRates?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/taxRates',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/taxRates');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/taxRates',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/taxRates?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/taxRates?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/taxRates?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/taxRates?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/taxRates?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/taxRates');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/taxRates');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/taxRates?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/taxRates?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/taxRates?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/taxRates"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/taxRates"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/taxRates?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/taxRates') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/taxRates";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/taxRates?page='http GET '{{baseUrl}}/companies/:companyId/data/taxRates?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/taxRates?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/taxRates?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get tracking categories
{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/trackingCategories/:trackingCategoryId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/trackingCategories/:trackingCategoryId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/trackingCategories/:trackingCategoryId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/trackingCategories/:trackingCategoryId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryIdhttp GET {{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/trackingCategories/:trackingCategoryId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List tracking categories
{{baseUrl}}/companies/:companyId/data/trackingCategories
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/data/trackingCategories?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/data/trackingCategories" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/data/trackingCategories?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/data/trackingCategories?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/data/trackingCategories?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/data/trackingCategories?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/data/trackingCategories?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/data/trackingCategories?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/data/trackingCategories?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/trackingCategories?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/data/trackingCategories?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/data/trackingCategories?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/trackingCategories',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/data/trackingCategories?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/data/trackingCategories?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/data/trackingCategories?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/data/trackingCategories?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/trackingCategories',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/data/trackingCategories');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/data/trackingCategories',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/data/trackingCategories?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/data/trackingCategories?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/data/trackingCategories?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/data/trackingCategories?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/data/trackingCategories?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/data/trackingCategories');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/data/trackingCategories');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/data/trackingCategories?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/data/trackingCategories?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/data/trackingCategories?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/data/trackingCategories"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/data/trackingCategories"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/data/trackingCategories?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/data/trackingCategories') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/data/trackingCategories";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/data/trackingCategories?page='http GET '{{baseUrl}}/companies/:companyId/data/trackingCategories?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/data/trackingCategories?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/data/trackingCategories?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create transfer
{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers" {:content-type :json})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers"),
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/companies/:companyId/connections/:connectionId/push/transfers HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers")
.header("content-type", "application/json")
.body("{}")
.asString(); const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/push/transfers',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers',
headers: {'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers",
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([
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/companies/:companyId/connections/:connectionId/push/transfers", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/companies/:companyId/connections/:connectionId/push/transfers') do |req|
req.body = "{}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers \
--header 'content-type: application/json' \
--data '{}'echo '{}' | \
http POST {{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfersimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/push/transfers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get create transfer model
{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/options/transfers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/options/transfers',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/options/transfers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/options/transfers') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfershttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/options/transferswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfersimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/options/transfers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Transfers to or from a bank account",
"displayName": "Transfer",
"properties": {
"contactRef": {
"description": "The customer or supplier for this transfer if known",
"displayName": "Contact Reference",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "customers",
"required": false,
"type": "String",
"value": "customers"
},
{
"displayName": "suppliers",
"required": false,
"type": "String",
"value": "suppliers"
}
],
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing customer or supplier.",
"field": "ContactRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"date": {
"description": "The date the transfer occurred",
"displayName": "Transfer Date",
"required": true,
"type": "DateTime"
},
"description": {
"description": "The description of the transfer",
"displayName": "Transfer Description",
"required": false,
"type": "String"
},
"from": {
"description": "The account and amount that money was transfered from",
"displayName": "Transfered From",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "chartOfAccounts",
"required": false,
"type": "String",
"value": "chartOfAccounts"
}
],
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing bank or nominal account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account).",
"field": "From.AccountRef"
}
]
}
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Transfer Amount must be greater than zero.",
"field": "From.Amount"
}
]
}
},
"currency": {
"description": "The currency of the transfer",
"displayName": "Currency",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"to": {
"description": "The account and amount that money was transfered to",
"displayName": "Transfered To",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "chartOfAccounts",
"required": false,
"type": "String",
"value": "chartOfAccounts"
}
],
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing bank or nominal account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account).",
"field": "To.AccountRef"
}
]
}
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Transfer Amount must be greater than zero.",
"field": "To.Amount"
}
]
}
},
"currency": {
"description": "The currency of the transfer",
"displayName": "Currency",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this transfer is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Transfers to or from a bank account",
"displayName": "Transfer",
"properties": {
"contactRef": {
"description": "The customer or supplier for this transfer if known",
"displayName": "Contact Reference",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "customers",
"required": false,
"type": "String",
"value": "customers"
},
{
"displayName": "suppliers",
"required": false,
"type": "String",
"value": "suppliers"
}
],
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing customer or supplier.",
"field": "ContactRef.Id"
}
]
}
}
},
"required": false,
"type": "Object"
},
"date": {
"description": "The date the transfer occurred",
"displayName": "Transfer Date",
"required": true,
"type": "DateTime"
},
"description": {
"description": "The description of the transfer",
"displayName": "Transfer Description",
"required": false,
"type": "String"
},
"from": {
"description": "The account and amount that money was transfered from",
"displayName": "Transfered From",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "chartOfAccounts",
"required": false,
"type": "String",
"value": "chartOfAccounts"
}
],
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing bank or nominal account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account).",
"field": "From.AccountRef"
}
]
}
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Transfer Amount must be greater than zero.",
"field": "From.Amount"
}
]
}
},
"currency": {
"description": "The currency of the transfer",
"displayName": "Currency",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"to": {
"description": "The account and amount that money was transfered to",
"displayName": "Transfered To",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "chartOfAccounts",
"required": false,
"type": "String",
"value": "chartOfAccounts"
}
],
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing bank or nominal account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account).",
"field": "To.AccountRef"
}
]
}
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Transfer Amount must be greater than zero.",
"field": "To.Amount"
}
]
}
},
"currency": {
"description": "The currency of the transfer",
"displayName": "Currency",
"required": false,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this transfer is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": false,
"type": "String"
}
},
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Transfers to or from a bank account",
"displayName": "Transfer",
"properties": {
"date": {
"description": "The date the transfer occurred",
"displayName": "Transfer Date",
"required": true,
"type": "DateTime"
},
"from": {
"description": "The account and amount that money was transfered from",
"displayName": "Transfered From",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing bank account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be provided and be greater than zero.",
"field": "From.Amount"
}
]
}
}
},
"required": true,
"type": "Object"
},
"to": {
"description": "The account and amount that money was transfered to",
"displayName": "Transfered To",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing bank account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": false,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "If provided, must be greater than zero.",
"field": "To.Amount"
},
{
"details": "It will be taken into account just if the accounts are in different currencies and will override the automatic currency conversion.",
"field": "To.Amount"
}
]
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Transfers to or from a bank account",
"displayName": "Transfer",
"properties": {
"date": {
"description": "The date the transfer occurred",
"displayName": "Transfer Date",
"required": false,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Will default to today's date if not provided",
"field": "Date"
}
],
"warnings": []
}
},
"depositedRecordRefs": {
"description": "A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer.",
"displayName": "Deposited Record References",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"description": {
"description": "The description of the transfer",
"displayName": "Transfer Description",
"required": false,
"type": "String"
},
"from": {
"description": "The account and amount that money was transfered from",
"displayName": "Transfered From",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"to": {
"description": "The account and amount that money was transfered to",
"displayName": "Transfered To",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this transfer is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "One location, one department and one classification may be provided",
"field": "TrackingCategoryRefs.Id"
}
]
}
}
},
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "Currently only transfers between bank accounts and undeposited funds accounts are supported"
}
]
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Transfers to or from a bank account",
"displayName": "Transfer",
"properties": {
"contactRef": {
"description": "The customer or supplier for this transfer if known",
"displayName": "Contact Reference",
"required": false,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "This value is not used in the push, and will be ignored.",
"field": "ContactRef"
}
]
}
},
"date": {
"description": "The date the transfer occurred",
"displayName": "Transfer Date",
"required": true,
"type": "DateTime"
},
"description": {
"description": "The description of the transfer",
"displayName": "Transfer Description",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Max length of 4096 characters.",
"field": "Description"
}
]
}
},
"from": {
"description": "The account and amount that money was transfered from",
"displayName": "Transfered From",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Value should match To.Amount",
"field": "From.Amount"
},
{
"details": "Value should be greater than zero",
"field": "From.Amount"
}
]
}
},
"currency": {
"description": "The currency of the transfer",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "This value is not used in the push, and will be ignored.",
"field": "From.Currency"
}
]
}
}
},
"required": true,
"type": "Object"
},
"sourceModifiedDate": {
"description": "The date the record was last changed in the originating system",
"displayName": "Source Modified Date",
"required": true,
"type": "DateTime"
},
"to": {
"description": "The account and amount that money was transfered to",
"displayName": "Transfered To",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Value should match To.Amount",
"field": "To.Amount"
},
{
"details": "Value should be greater than zero",
"field": "To.Amount"
}
]
}
},
"currency": {
"description": "The currency of the transfer",
"displayName": "Currency",
"required": false,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "This value is not used in the push, and will be ignored.",
"field": "To.Currency"
}
]
}
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this transfer is being tracked against",
"displayName": "Tracking Category References",
"required": false,
"type": "Array"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Transfers to or from a bank account",
"displayName": "Transfer",
"properties": {
"depositedRecordRefs": {
"description": "A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer.",
"displayName": "Deposited Record References",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "Payments",
"required": false,
"type": "String",
"value": "payments"
},
{
"displayName": "DirectIncomes",
"required": false,
"type": "String",
"value": "directIncomes"
},
{
"displayName": "JournalEntries",
"required": false,
"type": "String",
"value": "journalEntries"
}
],
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"description": {
"description": "The description of the transfer",
"displayName": "Transfer Description",
"required": false,
"type": "String"
},
"from": {
"description": "The account and amount that money was transfered from",
"displayName": "Transfered From",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"to": {
"description": "The account and amount that money was transfered to",
"displayName": "Transfered To",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer"
},
{
"details": "Transfers between accounts in different currencies can only be made if multi-currency is enabled for company"
},
{
"details": "The currency of at least one of the accounts used must be the same as the company's currency"
}
]
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Transfers to or from a bank account",
"displayName": "Transfer",
"properties": {
"depositedRecordRefs": {
"description": "A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer.",
"displayName": "Deposited Record References",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"options": [
{
"displayName": "Payments",
"required": false,
"type": "String",
"value": "payments"
},
{
"displayName": "DirectIncomes",
"required": false,
"type": "String",
"value": "directIncomes"
},
{
"displayName": "JournalEntries",
"required": false,
"type": "String",
"value": "journalEntries"
}
],
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": false,
"type": "Array"
},
"description": {
"description": "The description of the transfer",
"displayName": "Transfer Description",
"required": false,
"type": "String"
},
"from": {
"description": "The account and amount that money was transfered from",
"displayName": "Transfered From",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number"
}
},
"required": true,
"type": "Object"
},
"to": {
"description": "The account and amount that money was transfered to",
"displayName": "Transfered To",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object",
"validation": {
"information": [],
"warnings": [
{
"details": "When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer"
},
{
"details": "Transfers between accounts in different currencies can only be made if multi-currency is enabled for company"
},
{
"details": "The currency of at least one of the accounts used must be the same as the company's currency"
}
]
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Transfers to or from a bank account",
"displayName": "Transfer",
"properties": {
"date": {
"description": "The date the transfer occurred",
"displayName": "Transfer Date",
"required": true,
"type": "DateTime",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "Date"
}
],
"warnings": []
}
},
"description": {
"description": "The description of the transfer",
"displayName": "Transfer Description",
"required": false,
"type": "String",
"validation": {
"information": [
{
"details": "Must not be longer than 2000 characters.",
"field": "Description"
}
],
"warnings": [
{
"details": "Must be provided if pushing a bank deposit.",
"field": "Description"
}
]
}
},
"from": {
"description": "The account and amount that money was transfered from",
"displayName": "Transfered From",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be different from To.AccountRef.Id.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing bank account in the company's base currency.",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be equal to To.Amount.",
"field": "From.Amount"
},
{
"details": "Must be greater than zero.",
"field": "From.Amount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"to": {
"description": "The account and amount that money was transfered to",
"displayName": "Transfered To",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be different from From.AccountRef.Id.",
"field": "AccountRef.Id"
},
{
"details": "Must match the ID of an existing bank account in the company's base currency.",
"field": "AccountRef.Id"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [
{
"details": "Must be equal to From.Amount.",
"field": "To.Amount"
},
{
"details": "Must be greater than zero.",
"field": "To.Amount"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Transfers to or from a bank account",
"displayName": "Transfer",
"properties": {
"contactRef": {
"description": "The customer or supplier for this transfer if known",
"displayName": "Contact Reference",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"date": {
"description": "The date the transfer occurred",
"displayName": "Transfer Date",
"required": true,
"type": "DateTime"
},
"depositedRecordRefs": {
"description": "A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer.",
"displayName": "Deposited Record References",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
},
"description": {
"description": "The description of the transfer",
"displayName": "Transfer Description",
"required": true,
"type": "String"
},
"from": {
"description": "The account and amount that money was transfered from",
"displayName": "Transfered From",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"currency": {
"description": "The currency of the transfer",
"displayName": "Currency",
"required": true,
"type": "String"
},
"status": {
"description": "The status of the transfer in the account",
"displayName": "Status",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"metadata": {
"description": "Miscellaneous data about the item",
"displayName": "Metadata",
"properties": {
"isDeleted": {
"description": "A boolean to indicate whether the object has been deleted",
"displayName": "IsDeleted",
"required": true,
"type": "Boolean"
}
},
"required": true,
"type": "Object"
},
"to": {
"description": "The account and amount that money was transfered to",
"displayName": "Transfered To",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"dataType": {
"description": "The name of the data type for which the ID is valid.",
"displayName": "DataType",
"required": true,
"type": "String"
},
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number"
},
"currency": {
"description": "The currency of the transfer",
"displayName": "Currency",
"required": true,
"type": "String"
},
"status": {
"description": "The status of the transfer in the account",
"displayName": "Status",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Object"
},
"trackingCategoryRefs": {
"description": "A collection of categories this transfer is being tracked against",
"displayName": "Tracking Category References",
"properties": {
"id": {
"description": "The identifier for the item, unique per tracking category",
"displayName": "Identifier",
"required": true,
"type": "String"
},
"name": {
"description": "The name of the category referenced by the identifier",
"displayName": "Tracking Category Name",
"required": true,
"type": "String"
}
},
"required": true,
"type": "Array"
}
},
"required": true,
"type": "Object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Transfers to or from a bank account",
"displayName": "Transfer",
"properties": {
"date": {
"description": "The date the transfer occurred",
"displayName": "Transfer Date",
"required": true,
"type": "DateTime"
},
"from": {
"description": "The account and amount that money was transfered from",
"displayName": "Transfered From",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing bank account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be equal to To.Amount.",
"field": "From.Amount"
},
{
"details": "Must be greater than zero.",
"field": "From.Amount"
}
]
}
},
"status": {
"description": "The status of the transfer in the account",
"displayName": "Status",
"options": [
{
"displayName": "Unknown",
"required": false,
"type": "String",
"value": "Unknown"
},
{
"displayName": "Unreconciled",
"required": false,
"type": "String",
"value": "Unreconciled"
},
{
"displayName": "Reconciled",
"required": false,
"type": "String",
"value": "Reconciled"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "From.Status"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
},
"to": {
"description": "The account and amount that money was transfered to",
"displayName": "Transfered To",
"properties": {
"accountRef": {
"description": "Reference to the bank or nominal account",
"displayName": "Account Reference",
"properties": {
"id": {
"description": "The reference identifier for the record",
"displayName": "Identifier",
"required": true,
"type": "String",
"validation": {
"information": [],
"warnings": [
{
"details": "Must match the ID of an existing bank account.",
"field": "AccountRef.Id"
}
]
}
}
},
"required": true,
"type": "Object"
},
"amount": {
"description": "The amount transfered",
"displayName": "Amount",
"required": true,
"type": "Number",
"validation": {
"information": [],
"warnings": [
{
"details": "Must be equal to From.Amount.",
"field": "To.Amount"
},
{
"details": "Must be greater than zero.",
"field": "To.Amount"
}
]
}
},
"status": {
"description": "The status of the transfer in the account",
"displayName": "Status",
"options": [
{
"displayName": "Unknown",
"required": false,
"type": "String",
"value": "Unknown"
},
{
"displayName": "Unreconciled",
"required": false,
"type": "String",
"value": "Unreconciled"
},
{
"displayName": "Reconciled",
"required": false,
"type": "String",
"value": "Reconciled"
}
],
"required": true,
"type": "String",
"validation": {
"information": [
{
"details": "Must be provided.",
"field": "To.Status"
}
],
"warnings": []
}
}
},
"required": true,
"type": "Object"
}
},
"required": true,
"type": "Object"
}
GET
Get transfer
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId")require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/transfers/:transferId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/transfers/:transferId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/transfers/:transferId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/transfers/:transferId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferIdhttp GET {{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers/:transferId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List transfers
{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers
QUERY PARAMS
page
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers" {:query-params {:page ""}})require "http/client"
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/companies/:companyId/connections/:connectionId/data/transfers?page= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/companies/:companyId/connections/:connectionId/data/transfers?page=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers',
qs: {page: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers');
req.query({
page: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers',
params: {page: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=');
echo $response->getBody();setUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'page' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'page' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/companies/:companyId/connections/:connectionId/data/transfers?page=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers"
querystring = {"page":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers"
queryString <- list(page = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/companies/:companyId/connections/:connectionId/data/transfers') do |req|
req.params['page'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers";
let querystring = [
("page", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page='http GET '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/companies/:companyId/connections/:connectionId/data/transfers?page=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()