Biklo for developersTESTsandbox-api.biklo.comchange

One invoice, with the orders behind it

GET/v1/invoices/{number}

scope wallet.read

Pass series when a number could exist in more than one — a number is only unique within its series. lines breaks the invoice down per order, with what was owed, what was actually charged, and what was written off.

Query parameters#

NameExample
seriesRO_BK_COMRequired when the number is ambiguous

Response#

FieldTypeDescription
dataobjectOne invoice, with the per-order lines behind it.
data.idstringSeries and number together — the invoice's real identity. The number alone is only unique WITHIN a series, so never key on it by itself.
data.seriesstringThe document series. Sandbox documents carry an SBX_ prefix.
data.numberstringThe document number within that series.
data.currencystringThe invoice currency.
data.total_amountintegerWhat you were charged, in minor units — the platform and shipping fees added up. It EXCLUDES written_off_amount, which nobody charged you.
data.platform_fee_amountintegerOur commission on the covered orders.
data.shipping_fee_amountintegerCourier charges on the covered orders.
data.written_off_amountintegerWhat Biklo gave up because the fees you absorbed exceeded what the order was worth. Never charged to you, and on the document because it happened.
data.orders_countintegerHow many orders this invoice covers. Fee invoices are batched, so this is rarely 1.
data.issued_atstring|nullISO-8601 UTC.
data.pdf_urlstringPath to the PDF, relative to the API base. Fetch it with your key like any other call — do not treat it as a public link.
data.is_sandboxbooleantrue on a sandbox document, which is stamped NOT A FISCAL DOCUMENT. Stated in the payload so you never have to infer it from the series prefix.
data.linesarrayOne line per order on this invoice — the fee liabilities it settled.
data.lines[].idintegerThe liability id.
data.lines[].order_idinteger|nullWhich order it arose from.
data.lines[].currencystringIts currency.
data.lines[].owed_amountintegerWhat the order owed us in total — platform plus shipping fees.
data.lines[].charged_amountintegerWhat we actually took. This DIFFERS from owed_amount whenever a liability settled only partly, and reading one while assuming the other is how books stop balancing.
data.lines[].written_off_amountintegerThe difference we gave up rather than pursued.
data.lines[].platform_fee_amountintegerThe commission part of what was owed.
data.lines[].shipping_fee_amountintegerThe courier part of what was owed.
data.lines[].statusstringpending means not yet collected. settled means we took what we could — NOT necessarily all of it, so check written_off_amount before assuming the order paid in full. cancelled follows a refund.

Accepts pending · settled · cancelled

data.lines[].settled_atstring|nullISO-8601 UTC, or null while pending.
data.lines[].invoiceobject|nullThe invoice this landed on, once one was issued. null means it is owed but not yet invoiced — which is exactly what GET /v1/fee-liabilities is for.
data.lines[].invoice.seriesstringThe invoice series.
data.lines[].invoice.numberstringThe invoice number.
data.lines[].invoice.pdf_urlstringPath to that invoice's PDF.

Example

{
    "data": {
        "id": "RO_BK_COM/0524",
        "series": "RO_BK_COM",
        "number": "0524",
        "currency": "RON",
        "total_amount": 3950,
        "platform_fee_amount": 2100,
        "shipping_fee_amount": 1850,
        "written_off_amount": 350,
        "orders_count": 2,
        "issued_at": "2026-09-12T08:10:59Z",
        "pdf_url": "/v1/invoices/0524/pdf?series=RO_BK_COM",
        "is_sandbox": false,
        "lines": [
            {
                "id": 15,
                "order_id": 721,
                "currency": "RON",
                "owed_amount": 3050,
                "charged_amount": 3050,
                "written_off_amount": 0,
                "platform_fee_amount": 1800,
                "shipping_fee_amount": 1250,
                "status": "settled",
                "settled_at": "2026-09-12T08:09:40Z",
                "invoice": {
                    "series": "RO_BK_COM",
                    "number": "0524",
                    "pdf_url": "/v1/invoices/0524/pdf?series=RO_BK_COM"
                }
            }
        ]
    }
}

Failures use the shared error envelope — a machine-readable code and a request_id to quote to support. Error handling.

curl -X GET "https://sandbox-api.biklo.com/v1/invoices/0524?series=RO_BK_COM" \
  -H "Authorization: Bearer bk_test_YOUR_KEY"
<?php

$ch = curl_init('https://sandbox-api.biklo.com/v1/invoices/0524?series=RO_BK_COM');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'GET',
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer bk_test_YOUR_KEY',
    ],
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

using System.Net.Http;
using System.Net.Http.Headers;

var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "bk_test_YOUR_KEY");

var request = new HttpRequestMessage(
    new HttpMethod("GET"),
    "https://sandbox-api.biklo.com/v1/invoices/0524?series=RO_BK_COM");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import requests

response = requests.get(
    "https://sandbox-api.biklo.com/v1/invoices/0524?series=RO_BK_COM",
    headers={"Authorization": "Bearer bk_test_YOUR_KEY"},
)

data = response.json()

const response = await fetch("https://sandbox-api.biklo.com/v1/invoices/0524?series=RO_BK_COM", {
  method: "GET",
  headers: {
    Authorization: "Bearer bk_test_YOUR_KEY"
  }
});

const data = await response.json();

import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox-api.biklo.com/v1/invoices/0524?series=RO_BK_COM"))
    .header("Authorization", "Bearer bk_test_YOUR_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());