Get a period's ledger totals

GET

/periods/{period_id}/totals

curl --request GET \
  --url https://api.europlaybook.com/v1/periods/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/totals \
  --header 'Authorization: Bearer <token>'

• Production

The totals of the period’s last ledger build (by kind, material, household, obligated party), whether it is stale, what blocks closing it, and what a pack would declare.

Authorizations

• BearerTokenAuth

Parameters

Path Parameters

period_id

required

Period Id

string format: uuid

Responses

200

OK

Media typeapplication/json

PeriodTotalsOut

object

period

required

PeriodOut

object

id

required

Id

string format: uuid

legal_entity_id

required

Legal Entity Id

string format: uuid

jurisdiction

required

Jurisdiction

string

scheme

required

Scheme

string

report_type

required

Report Type

string

cadence

required

Cadence

string

starts_on

required

Starts On

string format: date

ends_on

required

Ends On

string format: date

status

required

Status

Open, review, closed, filed or reopened.

string

closed_at

Any of:

string

string format: date-time

null

null

built_at

Any of:

string

string format: date-time

null

null

stale

required

Stale

Facts or packaging changed since the last build.

boolean

blockers

required

Blockers

Why the period could not be closed right now (codes).

Array<string>

unknown_skus

required

Unknown Skus

integer

unconfirmed_products

required

Unconfirmed Products

integer

totals

required

Totals

Array<object>

TotalOut

object

kind

required

Kind

Product, packaging, parcel_packaging or adjustment.

string

material

Any of:

string

string

null

null

household

required

Household

boolean

obligated_party

required

Obligated Party

string

exclusion

required

Exclusion

string

fact_kind

required

Fact Kind

string

quantity

required

Quantity

integer

mass_mg

required

Mass Mg

integer

size_class

Any of:

string

string

null

null

parcels

Parcels

integer

0

declared

Declared

What a pack made from this build would declare (scheme lines).

Example

{
  "period": {
    "id": "0199f5a2-7c1e-7b4a-9d0e-3f6c2a1b8e44",
    "jurisdiction": "NL",
    "scheme": "verpact",
    "report_type": "declaration",
    "cadence": "yearly"
  },
  "totals": [
    {
      "parcels": 0
    }
  ]
}

400

Bad Request

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

401

Unauthorized

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

403

Forbidden

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

404

Not Found

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

409

Conflict

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

422

Unprocessable Content

Media typeapplication/json

PublicValidationErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

errors

Errors

Per-field problems (pydantic format: loc, msg, type).

Array<object>

default:

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  },
  "errors": []
}

429

Too Many Requests

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}