# e-Fatura Validator (UBL-TR 1.2.1) (`caulleonard/efatura-validator-standby`) Actor

GİB UBL-TR 1.2.1 e-Fatura (Invoice) doğrulama API'si: well-formed + XSD + Schematron iş kuralları. KVKK uyumlu, POST body-only, anlık yanıt.

- **URL**: https://apify.com/caulleonard/efatura-validator-standby.md
- **Developed by:** [Fatih Şahinbaş](https://apify.com/caulleonard) (community)
- **Categories:** Developer tools, E-commerce, Other
- **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.00 / 1,000 api calls

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## e-Fatura Validator (UBL-TR 1.2.1)

GİB (Gelir İdaresi Başkanlığı) **UBL-TR 1.2.1** e-Fatura (Invoice) belgelerini üç katmanda doğrulayan, her zaman açık (Standby) HTTP API.

Bir e-Fatura XML'i gönderirsiniz; servis belgenin **iyi biçimli (well-formed)** olup olmadığını, **XSD şemasına** uyup uymadığını ve **GİB iş kurallarına (Schematron)** uygun olup olmadığını kontrol eder. Yanıt; geçerlilik durumu, hatalı alanların konumu (XPath) ve GİB'in kendi hata mesajlarını içerir.

### Neden bu actor?

- **Resmi GİB paketleri** ile çalışır (UBL-TR 1.2.1 XSD + UBL-TR Schematron).
- **Üç katmanlı** gerçek doğrulama — sadece XSD değil, GİB iş kuralları (Schematron) dahil.
- **KVKK uyumlu**: fatura içeriği (ad, adres, VKN/TCKN, kalemler) **loglanmaz ve yanıtta geri döndürülmez**. Yalnızca yapısal hata bilgisi döner.
- **Standby** mod: REST API gibi anında yanıt, soğuk başlatma yok.

### Doğrulama katmanları

| Katman | Kontrol | Motor |
|--------|---------|-------|
| 1 | XML iyi biçimli mi | lxml |
| 2 | UBL-TR 1.2.1 XSD şema uyumu | lxml |
| 3 | GİB iş kuralları (Schematron / SVRL) | Saxon-HE |

**Not:** XSD (katman 2) başarısızsa Schematron (katman 3) atlanır — bozuk yapı üzerinde iş kuralı sonucu yanıltıcı olurdu. ZARF (`StandardBusinessDocument`) ile sarılı belgelerde içteki `Invoice` otomatik çıkarılır. Bu sürüm **Invoice** belge tipini doğrular.

### Kullanım

Standby HTTP endpoint'ine **POST** ile ham XML gönderin (gövde içinde — KVKK gereği query parametresinde değil).

#### Endpoint

````

POST  https://<actor-standby-url>/validate
Content-Type: application/xml
Body: <UBL-TR Invoice XML>

````

`GET /` çağrısı servis bilgisini döner; `GET /openapi.json` tam OpenAPI şemasını verir.

#### Örnek istek (curl)

```bash
curl -X POST "https://<actor-standby-url>/validate?token=<APIFY_TOKEN>" \
     -H "Content-Type: application/xml" \
     --data-binary "@fatura.xml"
````

#### Örnek yanıt

```json
{
  "isValid": false,
  "documentType": "Invoice",
  "ublVersion": "2.1",
  "layers": { "well_formed": true, "xsd": true, "schematron": false },
  "errorCount": 1,
  "errors": [
    {
      "layer": "schematron",
      "code": "business_rule_violation",
      "message": "Para birimi TRY olmayan belgelerde kur bilgisi zorunludur.",
      "line": null,
      "location": "/*[local-name()='Invoice']",
      "ruleTest": "not(cbc:DocumentCurrencyCode!='TRY') or cac:PricingExchangeRate/cbc:CalculationRate"
    }
  ]
}
```

Geçerli belgede `isValid: true`, `errorCount: 0` döner.

### Yanıt alanları

| Alan | Açıklama |
|------|----------|
| `isValid` | Tüm katmanlar geçtiyse `true` |
| `documentType` | Tespit edilen belge tipi (`Invoice`) |
| `ublVersion` | Belgedeki `cbc:UBLVersionID` değeri |
| `layers` | Her katmanın geç/kalma durumu |
| `errorCount` | Toplam hata sayısı |
| `errors[]` | Hata listesi: `layer`, `code`, `message`, `line`, `location` (XPath), `ruleTest` |

#### Hata kodları

`not_well_formed` · `no_invoice_in_envelope` · `unsupported_document_type` · `xsd_violation` · `business_rule_violation`

### Ücretlendirme

Pay-per-event: her doğrulama isteği (`api-call`) için sabit ücret. Belge geçerli olsun ya da olmasın ücretlendirilir — doğrulamanın kendisi hizmettir.

### KVKK / Gizlilik

Fatura XML içeriği yalnızca işlem süresince bellekte tutulur; **diske yazılmaz, loglanmaz**. Yanıttaki hata mesajları GİB'in standart kural metinleri ve yapısal XPath konumlarıdır — fatura içeriğindeki kişisel veriler (ad, adres, kimlik no, tutarlar) **asla yanıtta yer almaz**.

### Sınırlar / yol haritası

- Bu sürüm **Invoice** doğrular (ApplicationResponse / DespatchAdvice ileride).
- GİB paketi güncellendiğinde Schematron yeniden derlenir; sürüm bu README'de belirtilir.

***

*Bu actor resmi bir GİB ürünü değildir; resmi UBL-TR 1.2.1 paketlerini temel alır.*

# Actor input Schema

## Actor input object example

```json
{}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("caulleonard/efatura-validator-standby").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("caulleonard/efatura-validator-standby").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call caulleonard/efatura-validator-standby --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=caulleonard/efatura-validator-standby",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "e-Fatura Validator (UBL-TR 1.2.1)",
        "description": "GİB UBL-TR 1.2.1 e-Fatura (Invoice) doğrulama API'si: well-formed + XSD + Schematron iş kuralları. KVKK uyumlu, POST body-only, anlık yanıt.",
        "version": "0.0",
        "x-build-id": "hB4PACDRWGFP7pnsU"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/caulleonard~efatura-validator-standby/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-caulleonard-efatura-validator-standby",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/caulleonard~efatura-validator-standby/runs": {
            "post": {
                "operationId": "runs-sync-caulleonard-efatura-validator-standby",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/caulleonard~efatura-validator-standby/run-sync": {
            "post": {
                "operationId": "run-sync-caulleonard-efatura-validator-standby",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {}
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
