Cinema Payouts

Server

Cinema payouts and payout configuration.

List cinema payouts

GET

https://api.cineamo.com

/cinema-payouts

Returns a list of CinemaPayout objects.

List cinema payouts › query Parameters

page

integer

perPage

integer

sort

string

order

string

cinemaCompanyIds

integer[]

state

string

payoutType

string · enum

Enum values:

tickets

advertising

periodStart

string

periodEnd

string

List cinema payouts › Responses

200

CinemaPayout list

CinemaPayout

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string | null · readOnly

creditNoteNumber

string · readOnly

periodStart

string · readOnly

periodEnd

string · readOnly

state

string · readOnly

payoutType

string · enum · readOnly

Enum values:

tickets

advertising

Example: tickets

subtotalNet

integer · readOnly

taxAmount

integer · readOnly

totalGross

integer · readOnly

cineamoFeeNet

integer · readOnly

cashbackNet

integer · readOnly

stripeFeeNet

integer · readOnly

ticketSystemFeeNet

integer · readOnly

netMargin

integer · readOnly

pdfPath

string | null · readOnly

sentDatetime

string | null · readOnly

paidDatetime

string | null · readOnly

sepaExportedDatetime

string | null · readOnly

createdDatetime

string | null · readOnly

GET/cinema-payouts

curl https://api.cineamo.com/cinema-payouts

Example Responses

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Musterkino GmbH",
  "creditNoteNumber": "GS-2024-0001",
  "periodStart": "2024-01-01T00:00:00+00:00",
  "periodEnd": "2024-01-31T23:59:59+00:00",
  "state": "draft",
  "payoutType": "tickets",
  "subtotalNet": 10000,
  "taxAmount": 700,
  "totalGross": 10700,
  "cineamoFeeNet": 500,
  "cashbackNet": 200,
  "stripeFeeNet": 150,
  "ticketSystemFeeNet": 100,
  "netMargin": 50,
  "pdfPath": "payouts/2024/GS-2024-0001.pdf",
  "sentDatetime": "2024-02-01T10:00:00+00:00",
  "paidDatetime": "2024-02-05T10:00:00+00:00",
  "sepaExportedDatetime": "2024-02-04T09:00:00+00:00",
  "createdDatetime": "2024-02-01T08:00:00+00:00"
}

json

application/json

Create a cinema payout

POST

https://api.cineamo.com

/cinema-payouts

Create a draft CinemaPayout credit note. Period is computed by the system from the cinema company's payout config and last payout — no period input required.

Create a cinema payout › Request Body

cinemaCompany

integer · required

payoutType

string · enum · required

Enum values:

tickets

advertising

Example: tickets

Create a cinema payout › Responses

CinemaPayout created

CinemaPayout

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string | null · readOnly

creditNoteNumber

string · readOnly

periodStart

string · readOnly

periodEnd

string · readOnly

state

string · readOnly

payoutType

string · enum · readOnly

Enum values:

tickets

advertising

Example: tickets

subtotalNet

integer · readOnly

taxAmount

integer · readOnly

totalGross

integer · readOnly

cineamoFeeNet

integer · readOnly

cashbackNet

integer · readOnly

stripeFeeNet

integer · readOnly

ticketSystemFeeNet

integer · readOnly

netMargin

integer · readOnly

pdfPath

string | null · readOnly

sentDatetime

string | null · readOnly

paidDatetime

string | null · readOnly

sepaExportedDatetime

string | null · readOnly

createdDatetime

string | null · readOnly

POST/cinema-payouts

curl https://api.cineamo.com/cinema-payouts \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "cinemaCompany": 1,
  "payoutType": "tickets"
}'

Example Request Body

{
  "cinemaCompany": 1,
  "payoutType": "tickets"
}

json

Example Responses

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Musterkino GmbH",
  "creditNoteNumber": "GS-2024-0001",
  "periodStart": "2024-01-01T00:00:00+00:00",
  "periodEnd": "2024-01-31T23:59:59+00:00",
  "state": "draft",
  "payoutType": "tickets",
  "subtotalNet": 10000,
  "taxAmount": 700,
  "totalGross": 10700,
  "cineamoFeeNet": 500,
  "cashbackNet": 200,
  "stripeFeeNet": 150,
  "ticketSystemFeeNet": 100,
  "netMargin": 50,
  "pdfPath": "payouts/2024/GS-2024-0001.pdf",
  "sentDatetime": "2024-02-01T10:00:00+00:00",
  "paidDatetime": "2024-02-05T10:00:00+00:00",
  "sepaExportedDatetime": "2024-02-04T09:00:00+00:00",
  "createdDatetime": "2024-02-01T08:00:00+00:00"
}

json

application/json

Get a cinema payout liability

GET

https://api.cineamo.com

/cinema-payouts/liability

Returns the total outstanding fee-share liability Cineamo owes cinemas, broken down by cinema company.

Get a cinema payout liability › Responses

200

Outstanding payout liability breakdown

PayoutLiability

totalCents

integer · readOnly

PayoutLiabilityCompanyEntry[] · readOnly

totalGrossCents

integer · readOnly

Total outstanding payout liability across all companies, gross cents (incl. VAT).

Example: 5063240

List cinema payout line items

GET

https://api.cineamo.com

/cinema-payouts/{payoutId}/line-items

Returns a list of line items for a CinemaPayout.

List cinema payout line items › path Parameters

payoutId

integer · required

List cinema payout line items › query Parameters

page

integer

perPage

integer

List cinema payout line items › Responses

CinemaPayoutLineItem list

CinemaPayoutLineItem

id

integer · readOnly

description

string · readOnly

seatCategoryName

string | null · readOnly

priceDiscountName

string | null · readOnly

basePriceGross

integer · readOnly

quantity

integer · readOnly

amountNet

integer · readOnly

tax

integer · readOnly

taxAmount

integer · readOnly

amountGross

integer · readOnly

isRefund

boolean · readOnly

position

integer · readOnly

cinemaId

integer | null · readOnly

movieTitle

string | null · readOnly

distributorName

string | null · readOnly

impressionCount

integer | null · readOnly

campaignStart

string | null · readOnly

campaignEnd

string | null · readOnly

costPer1kImpressions

integer | null · readOnly

sharePercentage

integer | null · readOnly

List cinema payout order items

GET

https://api.cineamo.com

/cinema-payouts/{payoutId}/order-items

Returns a list of order items linked to a CinemaPayout.

List cinema payout order items › path Parameters

payoutId

integer · required

List cinema payout order items › query Parameters

page

integer

perPage

integer

List cinema payout order items › Responses

PayoutOrderItem list

PayoutOrderItem

id

integer · readOnly

orderId

integer | null · readOnly

cartItemId

integer · readOnly

productId

integer · readOnly

productSnapshot

string | null · readOnly

amount

integer | null · readOnly

amountNet

integer | null · readOnly

quantity

integer · readOnly

createdDatetime

string | null · readOnly

List pending cinema payouts

GET

https://api.cineamo.com

/cinema-payouts/pending

Returns the payout schedule: all active cinema payout configs with their next period, sorted most-overdue-first. Upcoming (not yet due) entries are included within a window.

List pending cinema payouts › query Parameters

upcomingWindowDays

integer

Default: 7

page

integer

perPage

integer

List pending cinema payouts › Responses

200

Pending payout schedule

PendingPayout

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string · readOnly

payoutConfigId

integer · readOnly

interval

string · readOnly

payoutType

string · enum · readOnly

Enum values:

tickets

advertising

Example: tickets

suggestedPeriodStart

string · readOnly

suggestedPeriodEnd

string · readOnly

daysOverdue

integer · readOnly

Positive = overdue, 0 = period ends today, negative = upcoming

Example: 18

lastPayoutId

integer | null · readOnly

lastPayoutCreditNoteNumber

string | null · readOnly

lastPayoutPeriodEnd

string | null · readOnly

existingPayoutId

integer | null · readOnly

Set when a non-finalized payout (draft/approved/sent) already covers the suggested period. The frontend must link here instead of offering a duplicate "Create" action.

Example: 12

existingPayoutCreditNoteNumber

string | null · readOnly

existingPayoutState

string | null · enum · readOnly

Enum values:

draft

approved

sent

Example: draft

Get a cinema payout

GET

https://api.cineamo.com

/cinema-payouts/{payoutId}

Returns a CinemaPayout. Use Accept: application/pdf to get the credit note PDF.

Get a cinema payout › path Parameters

payoutId

integer · required

Get a cinema payout › Responses

CinemaPayout details (JSON or PDF based on Accept header)

No data returned

Update a cinema payout

PATCH

https://api.cineamo.com

/cinema-payouts/{payoutId}

Updates a CinemaPayout state. It returns the updated CinemaPayout object.

Update a cinema payout › path Parameters

payoutId

integer · required

Update a cinema payout › Request Body

CinemaPayout

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string | null · readOnly

creditNoteNumber

string · readOnly

periodStart

string · readOnly

periodEnd

string · readOnly

state

string · readOnly

payoutType

string · enum · readOnly

Enum values:

tickets

advertising

Example: tickets

subtotalNet

integer · readOnly

taxAmount

integer · readOnly

totalGross

integer · readOnly

cineamoFeeNet

integer · readOnly

cashbackNet

integer · readOnly

stripeFeeNet

integer · readOnly

ticketSystemFeeNet

integer · readOnly

netMargin

integer · readOnly

pdfPath

string | null · readOnly

sentDatetime

string | null · readOnly

paidDatetime

string | null · readOnly

sepaExportedDatetime

string | null · readOnly

createdDatetime

string | null · readOnly

Update a cinema payout › Responses

CinemaPayout was updated

CinemaPayout

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string | null · readOnly

creditNoteNumber

string · readOnly

periodStart

string · readOnly

periodEnd

string · readOnly

state

string · readOnly

payoutType

string · enum · readOnly

Enum values:

tickets

advertising

Example: tickets

subtotalNet

integer · readOnly

taxAmount

integer · readOnly

totalGross

integer · readOnly

cineamoFeeNet

integer · readOnly

cashbackNet

integer · readOnly

stripeFeeNet

integer · readOnly

ticketSystemFeeNet

integer · readOnly

netMargin

integer · readOnly

pdfPath

string | null · readOnly

sentDatetime

string | null · readOnly

paidDatetime

string | null · readOnly

sepaExportedDatetime

string | null · readOnly

createdDatetime

string | null · readOnly

PATCH/cinema-payouts/{payoutId}

curl https://api.cineamo.com/cinema-payouts/:payoutId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Musterkino GmbH",
  "creditNoteNumber": "GS-2024-0001",
  "periodStart": "2024-01-01T00:00:00+00:00",
  "periodEnd": "2024-01-31T23:59:59+00:00",
  "state": "draft",
  "payoutType": "tickets",
  "subtotalNet": 10000,
  "taxAmount": 700,
  "totalGross": 10700,
  "cineamoFeeNet": 500,
  "cashbackNet": 200,
  "stripeFeeNet": 150,
  "ticketSystemFeeNet": 100,
  "netMargin": 50,
  "pdfPath": "payouts/2024/GS-2024-0001.pdf",
  "sentDatetime": "2024-02-01T10:00:00+00:00",
  "paidDatetime": "2024-02-05T10:00:00+00:00",
  "sepaExportedDatetime": "2024-02-04T09:00:00+00:00",
  "createdDatetime": "2024-02-01T08:00:00+00:00"
}'

Example Request Body

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Musterkino GmbH",
  "creditNoteNumber": "GS-2024-0001",
  "periodStart": "2024-01-01T00:00:00+00:00",
  "periodEnd": "2024-01-31T23:59:59+00:00",
  "state": "draft",
  "payoutType": "tickets",
  "subtotalNet": 10000,
  "taxAmount": 700,
  "totalGross": 10700,
  "cineamoFeeNet": 500,
  "cashbackNet": 200,
  "stripeFeeNet": 150,
  "ticketSystemFeeNet": 100,
  "netMargin": 50,
  "pdfPath": "payouts/2024/GS-2024-0001.pdf",
  "sentDatetime": "2024-02-01T10:00:00+00:00",
  "paidDatetime": "2024-02-05T10:00:00+00:00",
  "sepaExportedDatetime": "2024-02-04T09:00:00+00:00",
  "createdDatetime": "2024-02-01T08:00:00+00:00"
}

json

Example Responses

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Musterkino GmbH",
  "creditNoteNumber": "GS-2024-0001",
  "periodStart": "2024-01-01T00:00:00+00:00",
  "periodEnd": "2024-01-31T23:59:59+00:00",
  "state": "draft",
  "payoutType": "tickets",
  "subtotalNet": 10000,
  "taxAmount": 700,
  "totalGross": 10700,
  "cineamoFeeNet": 500,
  "cashbackNet": 200,
  "stripeFeeNet": 150,
  "ticketSystemFeeNet": 100,
  "netMargin": 50,
  "pdfPath": "payouts/2024/GS-2024-0001.pdf",
  "sentDatetime": "2024-02-01T10:00:00+00:00",
  "paidDatetime": "2024-02-05T10:00:00+00:00",
  "sepaExportedDatetime": "2024-02-04T09:00:00+00:00",
  "createdDatetime": "2024-02-01T08:00:00+00:00"
}

json

application/json

Send cinema payout

POST

https://api.cineamo.com

/cinema-payouts/{payoutId}/send

Send the credit-note PDF to the cinema company via e-mail. The payout must be in APPROVED state.

Send cinema payout › path Parameters

payoutId

integer · required

Send cinema payout › Responses

Credit note was sent. Payout state is now SENT.

CinemaPayout

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string | null · readOnly

creditNoteNumber

string · readOnly

periodStart

string · readOnly

periodEnd

string · readOnly

state

string · readOnly

payoutType

string · enum · readOnly

Enum values:

tickets

advertising

Example: tickets

subtotalNet

integer · readOnly

taxAmount

integer · readOnly

totalGross

integer · readOnly

cineamoFeeNet

integer · readOnly

cashbackNet

integer · readOnly

stripeFeeNet

integer · readOnly

ticketSystemFeeNet

integer · readOnly

netMargin

integer · readOnly

pdfPath

string | null · readOnly

sentDatetime

string | null · readOnly

paidDatetime

string | null · readOnly

sepaExportedDatetime

string | null · readOnly

createdDatetime

string | null · readOnly

POST/cinema-payouts/{payoutId}/send

curl https://api.cineamo.com/cinema-payouts/:payoutId/send \
  --request POST

Example Responses

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Musterkino GmbH",
  "creditNoteNumber": "GS-2024-0001",
  "periodStart": "2024-01-01T00:00:00+00:00",
  "periodEnd": "2024-01-31T23:59:59+00:00",
  "state": "draft",
  "payoutType": "tickets",
  "subtotalNet": 10000,
  "taxAmount": 700,
  "totalGross": 10700,
  "cineamoFeeNet": 500,
  "cashbackNet": 200,
  "stripeFeeNet": 150,
  "ticketSystemFeeNet": 100,
  "netMargin": 50,
  "pdfPath": "payouts/2024/GS-2024-0001.pdf",
  "sentDatetime": "2024-02-01T10:00:00+00:00",
  "paidDatetime": "2024-02-05T10:00:00+00:00",
  "sepaExportedDatetime": "2024-02-04T09:00:00+00:00",
  "createdDatetime": "2024-02-01T08:00:00+00:00"
}

json

application/json

Export cinema payouts SEPA

POST

https://api.cineamo.com

/cinema-payouts/sepa-export

Generate a SEPA pain.001.003.03 XML credit transfer file for the given approved payouts.

Export cinema payouts SEPA › Request Body

payoutIds

integer[] · required

Export cinema payouts SEPA › Responses

SEPA XML file (pain.001.003.03)

No data returned

POST

https://api.cineamo.com

/cinema-payout-configs/{payoutConfigId}/ads-share-rules

Creates a new ads-share rule for a CinemaPayoutConfig. Rules are immutable once created.

payoutConfigId

integer · required

CinemaPayoutConfig

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string · readOnly

interval

string · readOnly

adsInterval

string · readOnly

object[] · readOnly

bankAccountId

integer | null · readOnly

bankAccountIban

string | null · readOnly

isActive

boolean · readOnly

settledThrough

string | null

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Ads-share rule was created

CinemaPayoutConfig

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string · readOnly

interval

string · readOnly

adsInterval

string · readOnly

object[] · readOnly

bankAccountId

integer | null · readOnly

bankAccountIban

string | null · readOnly

isActive

boolean · readOnly

settledThrough

string | null

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

POST/cinema-payout-configs/{payoutConfigId}/ads-share-rules

curl https://api.cineamo.com/cinema-payout-configs/:payoutConfigId/ads-share-rules \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}'

Example Request Body

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}

json

Example Responses

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}

json

application/json

List cinema payout configs

GET

https://api.cineamo.com

/cinema-payout-configs

Returns a list of CinemaPayoutConfig objects.

List cinema payout configs › query Parameters

page

integer

perPage

integer

sort

string

order

string

cinemaCompanyIds

integer[]

isActive

boolean

List cinema payout configs › Responses

200

CinemaPayoutConfig list

CinemaPayoutConfig

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string · readOnly

interval

string · readOnly

adsInterval

string · readOnly

object[] · readOnly

bankAccountId

integer | null · readOnly

bankAccountIban

string | null · readOnly

isActive

boolean · readOnly

settledThrough

string | null

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

GET/cinema-payout-configs

curl https://api.cineamo.com/cinema-payout-configs

Example Responses

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}

json

application/json

Create a cinema payout config

POST

https://api.cineamo.com

/cinema-payout-configs

Creates a CinemaPayoutConfig. It returns the created CinemaPayoutConfig object.

Create a cinema payout config › Request Body

CinemaPayoutConfig

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string · readOnly

interval

string · readOnly

adsInterval

string · readOnly

object[] · readOnly

bankAccountId

integer | null · readOnly

bankAccountIban

string | null · readOnly

isActive

boolean · readOnly

settledThrough

string | null

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Create a cinema payout config › Responses

CinemaPayoutConfig was created

CinemaPayoutConfig

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string · readOnly

interval

string · readOnly

adsInterval

string · readOnly

object[] · readOnly

bankAccountId

integer | null · readOnly

bankAccountIban

string | null · readOnly

isActive

boolean · readOnly

settledThrough

string | null

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

POST/cinema-payout-configs

curl https://api.cineamo.com/cinema-payout-configs \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}'

Example Request Body

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}

json

Example Responses

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}

json

application/json

Get a cinema payout config

GET

https://api.cineamo.com

/cinema-payout-configs/{payoutConfigId}

Returns a CinemaPayoutConfig object by its Id.

Get a cinema payout config › path Parameters

payoutConfigId

integer · required

Get a cinema payout config › Responses

CinemaPayoutConfig details

CinemaPayoutConfig

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string · readOnly

interval

string · readOnly

adsInterval

string · readOnly

object[] · readOnly

bankAccountId

integer | null · readOnly

bankAccountIban

string | null · readOnly

isActive

boolean · readOnly

settledThrough

string | null

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

GET/cinema-payout-configs/{payoutConfigId}

curl https://api.cineamo.com/cinema-payout-configs/:payoutConfigId

Example Responses

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}

json

application/json

Update a cinema payout config

PATCH

https://api.cineamo.com

/cinema-payout-configs/{payoutConfigId}

Updates a CinemaPayoutConfig. It returns the updated CinemaPayoutConfig object.

Update a cinema payout config › path Parameters

payoutConfigId

integer · required

Update a cinema payout config › Request Body

CinemaPayoutConfig

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string · readOnly

interval

string · readOnly

adsInterval

string · readOnly

object[] · readOnly

bankAccountId

integer | null · readOnly

bankAccountIban

string | null · readOnly

isActive

boolean · readOnly

settledThrough

string | null

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Update a cinema payout config › Responses

CinemaPayoutConfig was updated

CinemaPayoutConfig

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string · readOnly

interval

string · readOnly

adsInterval

string · readOnly

object[] · readOnly

bankAccountId

integer | null · readOnly

bankAccountIban

string | null · readOnly

isActive

boolean · readOnly

settledThrough

string | null

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

PATCH/cinema-payout-configs/{payoutConfigId}

curl https://api.cineamo.com/cinema-payout-configs/:payoutConfigId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}'

Example Request Body

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}

json

Example Responses

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}

json

application/json

POST

https://api.cineamo.com

/cinema-payout-configs/{payoutConfigId}/fee-share-rules

Creates a new fee-share rule for a CinemaPayoutConfig. Rules are immutable once created.

payoutConfigId

integer · required

CinemaPayoutConfig

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string · readOnly

interval

string · readOnly

adsInterval

string · readOnly

object[] · readOnly

bankAccountId

integer | null · readOnly

bankAccountIban

string | null · readOnly

isActive

boolean · readOnly

settledThrough

string | null

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Fee-share rule was created

CinemaPayoutConfig

id

integer · readOnly

cinemaCompanyId

integer · readOnly

cinemaCompanyLegalName

string · readOnly

interval

string · readOnly

adsInterval

string · readOnly

object[] · readOnly

bankAccountId

integer | null · readOnly

bankAccountIban

string | null · readOnly

isActive

boolean · readOnly

settledThrough

string | null

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

POST/cinema-payout-configs/{payoutConfigId}/fee-share-rules

curl https://api.cineamo.com/cinema-payout-configs/:payoutConfigId/fee-share-rules \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}'

Example Request Body

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}

json

Example Responses

{
  "id": 1,
  "cinemaCompanyId": 1,
  "cinemaCompanyLegalName": "Kino GmbH",
  "interval": "monthly",
  "adsInterval": "monthly",
  "feeShareRules": [
    {
      "id": 1,
      "channelGroup": "cinema",
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "adsShareRules": [
    {
      "id": 1,
      "percentage": 0,
      "validFrom": "2024-01-01T00:00:00+00:00"
    }
  ],
  "bankAccountId": 1,
  "bankAccountIban": "DE89370400440532013000",
  "isActive": false,
  "settledThrough": "2026-05-31T00:00:00+00:00",
  "createdDatetime": "2024-01-01T00:00:00+00:00",
  "modifiedDatetime": "2024-01-01T00:00:00+00:00"
}

json

application/json

Cinema Partners Cinema Products

Cinema Payouts

List cinema payouts

List cinema payouts › query Parameters

List cinema payouts › Responses

Create a cinema payout

Create a cinema payout › Request Body

Create a cinema payout › Responses

Get a cinema payout liability

Get a cinema payout liability › Responses

List cinema payout line items

List cinema payout line items › path Parameters

List cinema payout line items › query Parameters

List cinema payout line items › Responses

List cinema payout order items

List cinema payout order items › path Parameters

List cinema payout order items › query Parameters

List cinema payout order items › Responses

List pending cinema payouts

List pending cinema payouts › query Parameters

List pending cinema payouts › Responses

Get a cinema payout

Get a cinema payout › path Parameters

Get a cinema payout › Responses

Update a cinema payout

Update a cinema payout › path Parameters

Update a cinema payout › Request Body

Update a cinema payout › Responses

Send cinema payout

Send cinema payout › path Parameters

Send cinema payout › Responses

Export cinema payouts SEPA

Export cinema payouts SEPA › Request Body

Export cinema payouts SEPA › Responses

Create a payout ads share rule

Create a payout ads share rule › path Parameters

Create a payout ads share rule › Request Body

Create a payout ads share rule › Responses

List cinema payout configs

List cinema payout configs › query Parameters

List cinema payout configs › Responses

Create a cinema payout config

Create a cinema payout config › Request Body

Create a cinema payout config › Responses

Get a cinema payout config

Get a cinema payout config › path Parameters

Get a cinema payout config › Responses

Update a cinema payout config

Update a cinema payout config › path Parameters

Update a cinema payout config › Request Body

Update a cinema payout config › Responses

Create a payout fee share rule

Create a payout fee share rule › path Parameters

Create a payout fee share rule › Request Body

Create a payout fee share rule › Responses