List invoices
curl --request GET \
--url https://api.yorlet.com/v1/invoices \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/invoices"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.yorlet.com/v1/invoices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/invoices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/invoices"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.yorlet.com/v1/invoices")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "invoice",
"application": "<string>",
"assignee": "<string>",
"credit_grant": "<string>",
"credit_grant_creation": {
"enabled": true,
"credit_grant_data": {
"applicability_config": {
"limits": {
"max_credit_per_invoice_item": 123
}
},
"name": "<string>"
}
},
"currency": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"customer": "<string>",
"customer_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"customer_email": "<string>",
"customer_name": "<string>",
"default_payment_method": "<string>",
"description": "<string>",
"discount": {},
"discount_amount": 123,
"due_date": 123,
"ending_balance": 123,
"finalized_at": 123,
"footer": "<string>",
"from_invoice": {
"action": "<string>",
"invoice": "<string>"
},
"hosted_invoice_url": "<string>",
"issuer": {
"owner": "<string>"
},
"last_finalization_error": {
"code": "<string>",
"message": "<string>"
},
"late_payment_failure_invoice": "<string>",
"latest_revision": "<string>",
"marked_uncollectible_at": 123,
"next_payment_attempt": 123,
"number": "<string>",
"number_transfer_reference": "<string>",
"off_platform_reference": "<string>",
"optimized_collection_date": 123,
"paid": true,
"paid_at": 123,
"paid_off_platform": true,
"payment_settings": {
"payment_method_types": []
},
"period": {
"end": 123,
"start": 123
},
"source_dispute": "<string>",
"starting_balance": 123,
"subscription": "<string>",
"transaction": "<string>",
"transfer_data": [
{
"id": "<string>",
"object": "<string>",
"amount": 123,
"description": "<string>",
"destination": "<string>",
"failure_code": "<string>",
"part_payment": "<string>",
"source_invoice_item": "<string>",
"status": "<string>",
"tax_reporting": {
"tax": 123,
"tax_percent": 123
},
"unit": "<string>"
}
],
"transfer_error": {
"message": "<string>",
"reason": "<string>"
},
"voided_at": 123,
"account": "<string>",
"deleted": false,
"amount_due": 0,
"amount_paid": 0,
"amount_remaining": 0,
"applied_balance": 0,
"apply_customer_balance": false,
"attempt_count": 0,
"attempted": false,
"auto_advance": false,
"late_payment_failure": false,
"metadata": {},
"part_payment_amount": 0,
"pending_part_payment": false,
"pending_transaction": false,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"subtotal": 0,
"tax": 0,
"total": 0,
"total_excluding_tax": 0,
"total_pretax_credit_amounts": [],
"total_tax_amounts": []
}
]
}Invoices
List invoices
List invoices
GET
/
v1
/
invoices
List invoices
curl --request GET \
--url https://api.yorlet.com/v1/invoices \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/invoices"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.yorlet.com/v1/invoices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/invoices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/invoices"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.yorlet.com/v1/invoices")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "invoice",
"application": "<string>",
"assignee": "<string>",
"credit_grant": "<string>",
"credit_grant_creation": {
"enabled": true,
"credit_grant_data": {
"applicability_config": {
"limits": {
"max_credit_per_invoice_item": 123
}
},
"name": "<string>"
}
},
"currency": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"customer": "<string>",
"customer_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"customer_email": "<string>",
"customer_name": "<string>",
"default_payment_method": "<string>",
"description": "<string>",
"discount": {},
"discount_amount": 123,
"due_date": 123,
"ending_balance": 123,
"finalized_at": 123,
"footer": "<string>",
"from_invoice": {
"action": "<string>",
"invoice": "<string>"
},
"hosted_invoice_url": "<string>",
"issuer": {
"owner": "<string>"
},
"last_finalization_error": {
"code": "<string>",
"message": "<string>"
},
"late_payment_failure_invoice": "<string>",
"latest_revision": "<string>",
"marked_uncollectible_at": 123,
"next_payment_attempt": 123,
"number": "<string>",
"number_transfer_reference": "<string>",
"off_platform_reference": "<string>",
"optimized_collection_date": 123,
"paid": true,
"paid_at": 123,
"paid_off_platform": true,
"payment_settings": {
"payment_method_types": []
},
"period": {
"end": 123,
"start": 123
},
"source_dispute": "<string>",
"starting_balance": 123,
"subscription": "<string>",
"transaction": "<string>",
"transfer_data": [
{
"id": "<string>",
"object": "<string>",
"amount": 123,
"description": "<string>",
"destination": "<string>",
"failure_code": "<string>",
"part_payment": "<string>",
"source_invoice_item": "<string>",
"status": "<string>",
"tax_reporting": {
"tax": 123,
"tax_percent": 123
},
"unit": "<string>"
}
],
"transfer_error": {
"message": "<string>",
"reason": "<string>"
},
"voided_at": 123,
"account": "<string>",
"deleted": false,
"amount_due": 0,
"amount_paid": 0,
"amount_remaining": 0,
"applied_balance": 0,
"apply_customer_balance": false,
"attempt_count": 0,
"attempted": false,
"auto_advance": false,
"late_payment_failure": false,
"metadata": {},
"part_payment_amount": 0,
"pending_part_payment": false,
"pending_transaction": false,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"subtotal": 0,
"tax": 0,
"total": 0,
"total_excluding_tax": 0,
"total_pretax_credit_amounts": [],
"total_tax_amounts": []
}
]
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Was this page helpful?
⌘I