cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/booking/BOOKING_ID/invoices?limit=20" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.bookings.get_booking_invoices("BOOKING_ID", {"limit": 20})
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.bookings.getBookingInvoices('BOOKING_ID', {limit: 20});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->bookings->getBookingInvoices('BOOKING_ID', ['limit' => 20]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.bookings.bookings_dto.BookingsDto.BookingInvoiceList;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<BookingInvoiceList> response = client.bookings().getBookingInvoices(
"BOOKING_ID",
Map.of("limit", 20));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Bookings.GetBookingInvoicesAsync(
"BOOKING_ID",
new Dictionary<string, object?> { ["limit"] = 20 });
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.bookings.getBookingInvoices(
'BOOKING_ID',
queryParams: {'limit': 20},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Bookings().GetBookingInvoices(context.Background(), "BOOKING_ID", map[string]any{"limit": 20}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"data": [
{
"account": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"alternate_billing_end_date": "<string>",
"alternate_billing_start_date": "<string>",
"alternate_due_date": "<string>",
"alternate_issue_date": "<string>",
"billing_end_date": "<string>",
"billing_start_date": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_form": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"customer_purchase_order_id": null,
"discount_amount": 123,
"due": "<string>",
"due_date": "<string>",
"id": "<string>",
"invoice_note": null,
"issue_date": "<string>",
"last_payment": null,
"last_updated_by": null,
"last_updated_on": null,
"object": "<string>",
"order": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"origin": null,
"paid": "<string>",
"payment_status": "<string>",
"price_tax_inclusive": true,
"status": "<string>",
"subtotal": "<string>",
"tax": "<string>",
"tax_total": "<string>",
"total": "<string>",
"type": "<string>",
"version": 123
}
],
"object": "<string>",
"pagination": {
"limit": 123,
"has_more": true,
"next_cursor": "<string>",
"prev_cursor": "<string>",
"links": {
"next": "<string>",
"prev": "<string>"
}
},
"url": "<string>"
}Bookings
List a booking's invoices
Lists the invoices raised for a booking, one page at a time.
GET
/
booking
/
{booking_id}
/
invoices
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/booking/BOOKING_ID/invoices?limit=20" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.bookings.get_booking_invoices("BOOKING_ID", {"limit": 20})
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.bookings.getBookingInvoices('BOOKING_ID', {limit: 20});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->bookings->getBookingInvoices('BOOKING_ID', ['limit' => 20]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.bookings.bookings_dto.BookingsDto.BookingInvoiceList;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<BookingInvoiceList> response = client.bookings().getBookingInvoices(
"BOOKING_ID",
Map.of("limit", 20));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Bookings.GetBookingInvoicesAsync(
"BOOKING_ID",
new Dictionary<string, object?> { ["limit"] = 20 });
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.bookings.getBookingInvoices(
'BOOKING_ID',
queryParams: {'limit': 20},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Bookings().GetBookingInvoices(context.Background(), "BOOKING_ID", map[string]any{"limit": 20}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"data": [
{
"account": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"alternate_billing_end_date": "<string>",
"alternate_billing_start_date": "<string>",
"alternate_due_date": "<string>",
"alternate_issue_date": "<string>",
"billing_end_date": "<string>",
"billing_start_date": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_form": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"customer_purchase_order_id": null,
"discount_amount": 123,
"due": "<string>",
"due_date": "<string>",
"id": "<string>",
"invoice_note": null,
"issue_date": "<string>",
"last_payment": null,
"last_updated_by": null,
"last_updated_on": null,
"object": "<string>",
"order": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"origin": null,
"paid": "<string>",
"payment_status": "<string>",
"price_tax_inclusive": true,
"status": "<string>",
"subtotal": "<string>",
"tax": "<string>",
"tax_total": "<string>",
"total": "<string>",
"type": "<string>",
"version": 123
}
],
"object": "<string>",
"pagination": {
"limit": 123,
"has_more": true,
"next_cursor": "<string>",
"prev_cursor": "<string>",
"links": {
"next": "<string>",
"prev": "<string>"
}
},
"url": "<string>"
}Returns one page of the booking’s invoices under
data. Each invoice names the booking in order. Other fields filter as filter_<field> for equality and filter_<field>_<operator> otherwise.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The booking's id. Any order's id works here, whatever the order's type.
Query Parameters
How many records to return on one page.
Example:
20
The next_cursor of the previous page, to read the page after it.
The field to sort by. Prefix it with - for descending order, as in -created_on.
Example:
"-created_on"