Reporting from subscription services

This service is only for customers with subscription model using the revenue share financial model. It will replace the reporting documented at Bokbasen distributes binaries to the end user.

Please note the following:

Single point of reporting. Bokbasen will distribute reports to all relevant product owners (publisher) to be used for invoicing the subscription service and calculation of royalty to authors, etc.
The report should only include reads above the threshold (i.e 10%), as agreed upon with the publisher.
All data within a reporting period must be delivered simultaneously.
If a product changes product owner within a reporting period, the product must be reported twice (one time on each owner)
Frequency as agreed upon with the publisher, but should not include partial months, making a month the shortest reporting period possible.

URL	https://api.dds.boknet t.no/usage/streaming
Method	POST
Request headers	Authorization	Required
	Date	Required


JSON attributes	isbn	Required	ISBN of the book you are reporting numbers for, mandatory
	periodFrom	Required	Start of the reporting period on the format yyyy-MM
	periodTo	Required	End of the reporting period on the format yyyy-MM
	productOwnerId	Required	Numeric ID of the publisher who owned the rights to the book during the reporting period
	productOwnerName	Optional	Name of the publisher who owned the rights to the book during the reporting period
	cost.totalCost	Required	The total cost that will be billed for this ISBN
	cost.paidCost	Optional	Can be sent in addition to cost.totalCost if you separate between trial and subscription
	cost.trialCost	Optional
	consumption.total	Required	The total amount of books read
	consumption.paid	Optional	Can be sent in addition to consumption.total if you separate between trial and subscription
	consumption.trial	Optional
	price.ppu	Required	The price per book read (price per unit)
	price.paidPpu	Optional	Can be sent in addition to price.ppu if you separate between trial and subscription
	price.trialPpu	Optional
	currency	Optional	The currency of the cost/ppu-fields
	market	Optional	The market you are reporting for
Response headers
Response body	Empty on success
Returns	204	No success
Returns	40x	On errors

Example (curl)

curl -v -X POST \
    -H "Authorization: Boknett TGT-232156-LFKUYpgAsxobxOMCAXnBXd7YxdmCRhWx91BYrgTHbcrfuflWRV-login.boknett.no" \
    -H  "Date: Thu, 12 Aug 2021 09:09:00 GMT" \
    --header "Content-Type: application/json" \
    --data-binary "@sales_data.json" \
    https://api.dds.boknett.no/usage/streaming

Example content of sales_data.json

{
  items: [
    {
      "isbn": "9782123456789",
      "period": "2021-05",
      "productOwnerId": "9999",
      "productOwnerName": "Example name",
      "cost": {
        "totalCost": "600",
        "paidCost": "450",
        "trialCost": "150"
      },
      "consumption": {
        "total": "30",
        "paid": "15",
        "trial": "15"
      },
      "price": {
        "ppu": "20",
        "paidPpu": "30",
        "trialPpu": "10"
      },
      "currency": "NOK",
      "market": "NO"
    }
  ], ...
}