Get one persisted billing statement by ID

GET

/api/v1/statements/{id}

const url = 'https://api-omni.linra.net/api/v1/statements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api-omni.linra.net/api/v1/statements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

partnerBearer

Parameters

Path Parameters

required

string format: uuid

Responses

200

The statement.

application/json

object

state

required

string

payload

required

details

object

payload

required

object

string format: uuid

partnerId

string format: uuid

partnerGlobalId

string

sequenceNumber

integer

statementNumber

string

periodFrom

string format: date-time

periodTo

string format: date-time

generatedAt

string format: date-time

locked

boolean

currency

string

totalDebits

number format: decimal

totalCredits

number format: decimal

netPosition

number format: decimal

emailStatus

string

emailStatusReason

string

nullable

emailSentAt

string format: date-time

nullable

document

object

partnerId

string format: uuid

partnerGlobalId

string

sequenceNumber

Null for a provisional (mode=report) document.

integer

nullable

statementNumber

string

nullable

isProvisional

boolean

periodFrom

string format: date-time

periodTo

string format: date-time

generatedAt

string format: date-time

currency

string

totalDebits

number format: decimal

totalCredits

number format: decimal

netPosition

number format: decimal

lines

Array<object>

object

transactionId

integer format: int64

timestamp

string format: date-time

transactionType

string

Allowed values: Debit Credit

referenceType

string

referenceId

string

amount

number format: decimal

balanceAfter

number format: decimal

notes

string

nullable

orderGoodsVatAmount

number

nullable

orderCommissionVatAmount

number

nullable

orderTotalAmountWithVat

number

nullable

orderTotalCommissionWithVat

number

nullable

platformTaxRegistrationNumber

string

nullable

partnerTaxRegistrationNumber

string

nullable

documentNature

string

Example

{
  "state": "SUCCESS",
  "payload": {
    "currency": "SAR",
    "document": {
      "statementNumber": "STMT-PTR-EXAMPLE-0001-14",
      "currency": "SAR",
      "lines": [
        {
          "transactionType": "Debit",
          "referenceType": "Order"
        }
      ],
      "documentNature": "This is a commercial billing document for informational and reconciliation purposes. It is NOT a ZATCA-compliant legal tax invoice."
    }
  }
}

404

Unknown statement, or one belonging to another partner (no existence leak).

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Examples

notFound

{
  "state": "NOT_FOUND_STATEMENT",
  "payload": null,
  "details": {}
}

429

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

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Example

{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

Headers

Retry-After

integer

Seconds to wait before retrying.