List linked invoices of every category
curl --request GET \
--url http://localhost:3500/v1/invoices/{id}/matched-invoices \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/invoices/{id}/matched-invoices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/invoices/{id}/matched-invoices"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"title": "<string>",
"category": "invoice",
"issued_date": "2023-12-25",
"currency_code": "<string>",
"total_amount_including_vat": "<string>",
"total_amount_excluding_vat": "<string>",
"supplier_name": "<string>",
"deleted_at": "2023-11-07T05:31:56Z"
},
"match_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"active": true
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "validation_error",
"message": "Invalid match request, including linking an invoice to itself.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "Invalid pair, inactive invoice, or a concurrent scope change. Retry scope conflicts.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Invoices
List linked invoices of every category
Reads both directions, including retained inactive relationships. Follow next_cursor for all matches. Only active relationships provide credit coverage.
List linked invoices of every category
curl --request GET \
--url http://localhost:3500/v1/invoices/{id}/matched-invoices \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/invoices/{id}/matched-invoices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/invoices/{id}/matched-invoices"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"title": "<string>",
"category": "invoice",
"issued_date": "2023-12-25",
"currency_code": "<string>",
"total_amount_including_vat": "<string>",
"total_amount_excluding_vat": "<string>",
"supplier_name": "<string>",
"deleted_at": "2023-11-07T05:31:56Z"
},
"match_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"active": true
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "validation_error",
"message": "Invalid match request, including linking an invoice to itself.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "Invalid pair, inactive invoice, or a concurrent scope change. Retry scope conflicts.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
ApiKeyBearerClerkSessionBearer
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.
Path Parameters
Query Parameters
Maximum number of results per page.
Required range:
1 <= x <= 100Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.
Maximum string length:
4096