Get statement by number

Billing

GET/api/v1/statements/by-number/{statementNumber}

Returns one of your billing statements, including its full rendered document — same shape as GET /api/v1/statements/{id}, resolved by its human-facing statement number (e.g. STMT-...-3) instead of its ID. Self-only — a statement belonging to another partner, or an unknown/malformed statement number, returns 404.

Path parameters

statementNumberstringRequired

The statement number, e.g. STMT-…-3.

Response

idstring (uuid)

statementNumberstring

sequenceNumberinteger

period.fromstring (date-time)

period.tostring (date-time)

generatedAtstring (date-time)

currencystring

totals.debitsnumber (decimal)

totals.creditsnumber (decimal)

totals.netnumber (decimal)

lockedboolean

document.sequenceNumberinteger

Null for a provisional (on-demand report) document.

document.statementNumberstring

document.isProvisionalboolean

document.periodobject

R-CATEGORIZE grouping for a statement/document’s period window.

document.generatedAtstring (date-time)

document.currencystring

document.totalsobject

R-CATEGORIZE grouping for a statement/document’s debit/credit/net rollup.

document.linesarray of object

document.documentNaturestring

document.isZatcaCompliantTaxInvoiceboolean

Always false — a machine-readable reinforcement of documentNature. Linra is the data source for ZATCA e-invoicing, never the invoice issuer.

Other responses

401No bearer token (UNAUTHORIZED_MISSING_TOKEN), an invalid token (UNAUTHORIZED_INVALID_TOKEN) or an expired one (UNAUTHORIZED_TOKEN_EXPIRED — mint a new token). UPSTREAM_AUTH_FAILED is different: a dependent service refused the Gateway itself. That is a server-side fault — retry later and do NOT re-mint your token. See the Errors guide.

403The route is not available to your credential (FORBIDDEN).

404Unknown/malformed statement number, or one belonging to another partner (no existence leak).

429Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).

502A dependent service returned an invalid response (BAD_GATEWAY). Retry with backoff.

503The service is temporarily unavailable (SERVICE_UNAVAILABLE). Retry with backoff.

504A dependent service did not respond in time (GATEWAY_TIMEOUT). Retry with backoff.

cURL

curl --request GET \
  --url https://api-omni.linra.net/api/v1/statements/by-number/value \
  --header 'Authorization: Bearer $TOKEN'

JavaScript

const res = await fetch('https://api-omni.linra.net/api/v1/statements/by-number/value', {
  headers: {
    Authorization: `Bearer ${token}`,
  },
});
const { payload } = await res.json();

C#

var response = await httpClient.GetAsync("https://api-omni.linra.net/api/v1/statements/by-number/value");

var envelope = await response.Content.ReadFromJsonAsync<ApiResponse<PartnerStatementResponse>>();

Response

{
  "state": "SUCCESS",
  "payload": {
    "id": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
    "statementNumber": "string",
    "sequenceNumber": 0,
    "period": {
      "from": "2026-08-22T09:14:03Z",
      "to": "2026-08-22T09:14:03Z"
    },
    "generatedAt": "2026-08-22T09:14:03Z",
    "currency": "SAR",
    "totals": {
      "debits": 0,
      "credits": 0,
      "net": 0
    },
    "locked": true,
    "document": {
      "sequenceNumber": 0,
      "statementNumber": "STMT-PTR-EXAMPLE-0001-14",
      "isProvisional": true,
      "period": {
        "from": "2026-08-22T09:14:03Z",
        "to": "2026-08-22T09:14:03Z"
      },
      "generatedAt": "2026-08-22T09:14:03Z",
      "currency": "SAR",
      "totals": {
        "debits": 0,
        "credits": 0,
        "net": 0
      },
      "lines": [
        {
          "timestamp": "2026-08-22T09:14:03Z",
          "transactionType": "Debit",
          "referenceType": "Order",
          "amount": 0,
          "balanceAfter": 0,
          "orderGoodsVatAmount": 0,
          "orderCommissionVatAmount": 0,
          "orderTotalAmountWithVat": 0,
          "orderTotalCommissionWithVat": 0,
          "orderShippingFeeAmount": 0,
          "orderShippingFeeVatAmount": 0,
          "orderShippingFeeAmountWithVat": 0,
          "platformTaxRegistrationNumber": "string",
          "partnerTaxRegistrationNumber": "string",
          "orderPartnerIsVatRegistered": true,
          "orderGoodsTaxClassification": "Standard"
        }
      ],
      "documentNature": "This is a commercial billing document for informational and reconciliation purposes. It is NOT a ZATCA-compliant legal tax invoice.",
      "isZatcaCompliantTaxInvoice": true
    }
  },
  "details": null
}