Revenue Share

GET

https://partner-api.monta.com

/api/v1/revenue-share/agreements

Required scope: revenue-share:read

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

status

string · enum

Filter by lifecycle status.

Enum values:

Active

Paused

Other

Example: Active

policyCode

string | null

Filter by the code of the applied policy.

Example: P-ACME-3

sourceTeamId

integer | null · int64

Filter by the team the revenue is shared from.

Example: 1024

recipientTeamId

integer | null · int64

Filter by the team the revenue is shared to.

Example: 2048

Revenue-share agreements matching the filters

OffsetBasedResponse_48

RevenueShareAgreement[] · required

MontaPage.Meta · required

GET/api/v1/revenue-share/agreements

curl https://partner-api.monta.com/api/v1/revenue-share/agreements \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "code": "A-ACME-7",
      "policyCode": "P-ACME-3",
      "policyVersion": 1,
      "sourceTeamId": 1024,
      "sourceTeamName": "Acme Fleet",
      "recipientTeamId": 2048,
      "recipientTeamName": "Acme Sites",
      "attributionSourceTeamId": 1024,
      "status": "Active",
      "startedAt": "2026-01-01T00:00:00Z",
      "endedAt": "2026-12-31T23:59:59Z",
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

POST

https://partner-api.monta.com

/api/v1/revenue-share/agreements

Required scope: revenue-share:write. Applies the policy identified by policyCode to the team pair.

Clients may send an Idempotency-Key header for safe retry semantics; the header is currently accepted and ignored (no enforcement yet).

Idempotency-Key

string

Opaque client-supplied key used for safe retries. Accepted today; behavior not yet enforced.

Example: 01HX5Z6Q1ABC1234FZ7K9PQRDE

ApplyRevenueShareAgreement

policyCode

string · minLength: 1 · required

Code of the policy this agreement applies.

Example: P-ACME-3

sourceTeamId

integer · int64 · required

Id of the team the revenue is shared from.

Example: 1024

recipientTeamId

integer · int64 · required

Id of the team the revenue is shared to.

Example: 2048

attributionSourceTeamId

integer | null · int64

Optional id of the team charges are attributed to.

Example: 1024

startedAt

string | null · date-time

Optional start of the agreement.

Example: 2026-01-01T00:00:00Z

The created revenue-share agreement

RevenueShareAgreement

code

string · required

Stable code identifying the agreement.

Example: A-ACME-7

status

string · enum · required

Lifecycle status.

Enum values:

Active

Paused

Other

Example: Active

policyCode

string | null

Code of the policy this agreement applies.

Example: P-ACME-3

policyVersion

integer | null · int32

Version of the policy this agreement applies.

Example: 1

sourceTeamId

integer | null · int64

Id of the team the revenue is shared from.

Example: 1024

sourceTeamName

string | null

Name of the team the revenue is shared from.

Example: Acme Fleet

recipientTeamId

integer | null · int64

Id of the team the revenue is shared to.

Example: 2048

recipientTeamName

string | null

Name of the team the revenue is shared to.

Example: Acme Sites

attributionSourceTeamId

integer | null · int64

Id of the team charges are attributed to.

Example: 1024

startedAt

string | null · date-time

When the agreement started.

Example: 2026-01-01T00:00:00Z

endedAt

string | null · date-time

When the agreement ended.

Example: 2026-12-31T23:59:59Z

createdAt

string | null · date-time

Creation timestamp.

updatedAt

string | null · date-time

Last update timestamp.

POST/api/v1/revenue-share/agreements

curl https://partner-api.monta.com/api/v1/revenue-share/agreements \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "policyCode": "P-ACME-3",
  "sourceTeamId": 1024,
  "recipientTeamId": 2048,
  "attributionSourceTeamId": 1024,
  "startedAt": "2026-01-01T00:00:00Z"
}'

Example Request Body

{
  "policyCode": "P-ACME-3",
  "sourceTeamId": 1024,
  "recipientTeamId": 2048,
  "attributionSourceTeamId": 1024,
  "startedAt": "2026-01-01T00:00:00Z"
}

json

Example Responses

{
  "code": "A-ACME-7",
  "policyCode": "P-ACME-3",
  "policyVersion": 1,
  "sourceTeamId": 1024,
  "sourceTeamName": "Acme Fleet",
  "recipientTeamId": 2048,
  "recipientTeamName": "Acme Sites",
  "attributionSourceTeamId": 1024,
  "status": "Active",
  "startedAt": "2026-01-01T00:00:00Z",
  "endedAt": "2026-12-31T23:59:59Z",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

GET

https://partner-api.monta.com

/api/v1/revenue-share/agreements/{code}

Required scope: revenue-share:read

code

string · required

Revenue-share agreement with the provided code

RevenueShareAgreement

code

string · required

Stable code identifying the agreement.

Example: A-ACME-7

status

string · enum · required

Lifecycle status.

Enum values:

Active

Paused

Other

Example: Active

policyCode

string | null

Code of the policy this agreement applies.

Example: P-ACME-3

policyVersion

integer | null · int32

Version of the policy this agreement applies.

Example: 1

sourceTeamId

integer | null · int64

Id of the team the revenue is shared from.

Example: 1024

sourceTeamName

string | null

Name of the team the revenue is shared from.

Example: Acme Fleet

recipientTeamId

integer | null · int64

Id of the team the revenue is shared to.

Example: 2048

recipientTeamName

string | null

Name of the team the revenue is shared to.

Example: Acme Sites

attributionSourceTeamId

integer | null · int64

Id of the team charges are attributed to.

Example: 1024

startedAt

string | null · date-time

When the agreement started.

Example: 2026-01-01T00:00:00Z

endedAt

string | null · date-time

When the agreement ended.

Example: 2026-12-31T23:59:59Z

createdAt

string | null · date-time

Creation timestamp.

updatedAt

string | null · date-time

Last update timestamp.

PATCH

https://partner-api.monta.com

/api/v1/revenue-share/agreements/{code}

Required scope: revenue-share:write

code

string · required

UpdateRevenueShareAgreement

endedAt

string | null · date-time

When the agreement ended.

startedAt

string | null · date-time

When the agreement started.

attributionSourceTeamId

integer | null · int64

Optional id of the team charges are attributed to.

The updated revenue-share agreement

RevenueShareAgreement

code

string · required

Stable code identifying the agreement.

Example: A-ACME-7

status

string · enum · required

Lifecycle status.

Enum values:

Active

Paused

Other

Example: Active

policyCode

string | null

Code of the policy this agreement applies.

Example: P-ACME-3

policyVersion

integer | null · int32

Version of the policy this agreement applies.

Example: 1

sourceTeamId

integer | null · int64

Id of the team the revenue is shared from.

Example: 1024

sourceTeamName

string | null

Name of the team the revenue is shared from.

Example: Acme Fleet

recipientTeamId

integer | null · int64

Id of the team the revenue is shared to.

Example: 2048

recipientTeamName

string | null

Name of the team the revenue is shared to.

Example: Acme Sites

attributionSourceTeamId

integer | null · int64

Id of the team charges are attributed to.

Example: 1024

startedAt

string | null · date-time

When the agreement started.

Example: 2026-01-01T00:00:00Z

endedAt

string | null · date-time

When the agreement ended.

Example: 2026-12-31T23:59:59Z

createdAt

string | null · date-time

Creation timestamp.

updatedAt

string | null · date-time

Last update timestamp.

PATCH/api/v1/revenue-share/agreements/{code}

curl https://partner-api.monta.com/api/v1/revenue-share/agreements/:code \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "endedAt": "2024-08-25T15:00:00Z",
  "startedAt": "2024-08-25T15:00:00Z",
  "attributionSourceTeamId": 1
}'

Example Request Body

{
  "endedAt": "2024-08-25T15:00:00Z",
  "startedAt": "2024-08-25T15:00:00Z",
  "attributionSourceTeamId": 1
}

json

Example Responses

{
  "code": "A-ACME-7",
  "policyCode": "P-ACME-3",
  "policyVersion": 1,
  "sourceTeamId": 1024,
  "sourceTeamName": "Acme Fleet",
  "recipientTeamId": 2048,
  "recipientTeamName": "Acme Sites",
  "attributionSourceTeamId": 1024,
  "status": "Active",
  "startedAt": "2026-01-01T00:00:00Z",
  "endedAt": "2026-12-31T23:59:59Z",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

DELETE

https://partner-api.monta.com

/api/v1/revenue-share/agreements/{code}

Required scope: revenue-share:delete

code

string · required

The revenue-share agreement was deleted

No data returned

POST

https://partner-api.monta.com

/api/v1/revenue-share/agreements/{code}/pause

Required scope: revenue-share:write.

code

string · required

The paused revenue-share agreement

RevenueShareAgreement

code

string · required

Stable code identifying the agreement.

Example: A-ACME-7

status

string · enum · required

Lifecycle status.

Enum values:

Active

Paused

Other

Example: Active

policyCode

string | null

Code of the policy this agreement applies.

Example: P-ACME-3

policyVersion

integer | null · int32

Version of the policy this agreement applies.

Example: 1

sourceTeamId

integer | null · int64

Id of the team the revenue is shared from.

Example: 1024

sourceTeamName

string | null

Name of the team the revenue is shared from.

Example: Acme Fleet

recipientTeamId

integer | null · int64

Id of the team the revenue is shared to.

Example: 2048

recipientTeamName

string | null

Name of the team the revenue is shared to.

Example: Acme Sites

attributionSourceTeamId

integer | null · int64

Id of the team charges are attributed to.

Example: 1024

startedAt

string | null · date-time

When the agreement started.

Example: 2026-01-01T00:00:00Z

endedAt

string | null · date-time

When the agreement ended.

Example: 2026-12-31T23:59:59Z

createdAt

string | null · date-time

Creation timestamp.

updatedAt

string | null · date-time

Last update timestamp.

POST

https://partner-api.monta.com

/api/v1/revenue-share/agreements/{code}/resume

Required scope: revenue-share:write.

code

string · required

The resumed revenue-share agreement

RevenueShareAgreement

code

string · required

Stable code identifying the agreement.

Example: A-ACME-7

status

string · enum · required

Lifecycle status.

Enum values:

Active

Paused

Other

Example: Active

policyCode

string | null

Code of the policy this agreement applies.

Example: P-ACME-3

policyVersion

integer | null · int32

Version of the policy this agreement applies.

Example: 1

sourceTeamId

integer | null · int64

Id of the team the revenue is shared from.

Example: 1024

sourceTeamName

string | null

Name of the team the revenue is shared from.

Example: Acme Fleet

recipientTeamId

integer | null · int64

Id of the team the revenue is shared to.

Example: 2048

recipientTeamName

string | null

Name of the team the revenue is shared to.

Example: Acme Sites

attributionSourceTeamId

integer | null · int64

Id of the team charges are attributed to.

Example: 1024

startedAt

string | null · date-time

When the agreement started.

Example: 2026-01-01T00:00:00Z

endedAt

string | null · date-time

When the agreement ended.

Example: 2026-12-31T23:59:59Z

createdAt

string | null · date-time

Creation timestamp.

updatedAt

string | null · date-time

Last update timestamp.

GET

https://partner-api.monta.com

/api/v1/revenue-share/calculations

Required scope: revenue-share:read

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

policyCode

string | null

Filter by the policy code the calculation applied.

Example: P-ACME-3

agreementCode

string | null

Filter by the agreement code the calculation belongs to.

Example: A-ACME-3

sourceTeamId

string | null

Filter by the team that generated the revenue.

Example: 10

recipientTeamId

string | null

Filter by the team receiving the share.

Example: 20

dateFrom

string | null · date-time

Return calculations computed on or after this timestamp (ISO 8601, e.g. 2026-01-01T00:00:00Z).

Example: 2026-01-01T00:00:00Z

dateTo

string | null · date-time

Return calculations computed on or before this timestamp (ISO 8601, e.g. 2026-01-31T23:59:59Z).

Example: 2026-01-31T23:59:59Z

settlementStatus

string | null

Filter by settlement status.

Example: settled

sort

string | null

Sort expression, prefixed with - for descending.

Example: -computed_at

Revenue-share calculations matching the filters

OffsetBasedResponse_49

RevenueShareCalculation[] · required

MontaPage.Meta · required

GET/api/v1/revenue-share/calculations

curl https://partner-api.monta.com/api/v1/revenue-share/calculations \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "C-ACME-1",
      "agreementCode": "A-ACME-3",
      "policyCode": "P-ACME-3",
      "sourceTeamId": "10",
      "sourceTeamName": "Source Team",
      "recipientTeamId": "20",
      "recipientTeamName": "Recipient Team",
      "chargeId": "999",
      "grossAmount": 100,
      "netAmount": 80,
      "attributedNetAmount": 80,
      "shareAmount": 12,
      "shareTaxAmount": 3,
      "shareTaxRate": 25,
      "shareTaxCode": "VAT_DK",
      "currency": "DKK",
      "settlementStatus": "settled",
      "walletTransactionId": "555",
      "externalSettledAt": "2026-02-01T00:00:00Z",
      "computedAt": "2026-01-15T00:00:00Z",
      "errorReason": "errorReason"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

GET

https://partner-api.monta.com

/api/v1/revenue-share/policies

Required scope: revenue-share:read

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

status

string · enum

Filter by lifecycle status.

Enum values:

Draft

Active

Example: Active

kind

string · enum

Filter by policy kind.

Enum values:

team_to_team

operator_to_team

Example: operator_to_team

moneyFlow

string · enum

Filter by money flow.

Enum values:

wallet_live

wallet_monthly

external

Example: wallet_live

search

string | null

Free-text match on code, name or description.

includeDeleted

boolean | null

Include soft-deleted policies in the results.

Example: true

Revenue-share policies matching the filters

OffsetBasedResponse_50

RevenueSharePolicy[] · required

MontaPage.Meta · required

GET/api/v1/revenue-share/policies

curl https://partner-api.monta.com/api/v1/revenue-share/policies \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "code": "P-ACME-3",
      "name": "Fleet 85/15",
      "description": "description",
      "kind": "operator_to_team",
      "seller": "cpo",
      "policyType": "percentage",
      "policyValue": 15,
      "moneyFlow": "wallet_live",
      "status": "Active",
      "version": 1,
      "validFrom": "2026-01-01T00:00:00Z",
      "validTo": "2026-12-31T23:59:59Z",
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "deletedAt": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

POST

https://partner-api.monta.com

/api/v1/revenue-share/policies

Required scope: revenue-share:write. The policy is created in Draft status.

CreateRevenueSharePolicy

name

string · minLength: 1 · required

Human-readable name.

Example: Fleet 85/15

kind

string · enum · required

Who the revenue is shared between.

Enum values:

team_to_team

operator_to_team

Example: operator_to_team

seller

string · enum · required

Who sells the electricity.

Enum values:

cpo

site_owner

Example: cpo

policyType

string · enum · required

How the share is measured.

Enum values:

percentage

per_kwh

Example: percentage

policyValue

number · min: 0 · required

The share value: a percentage of net, or an amount per kWh.

Example: 15

moneyFlow

string · enum · required

How the settled share reaches the recipient.

Enum values:

wallet_live

wallet_monthly

external

Example: wallet_live

validFrom

string · date-time · required

Start of the validity window.

Example: 2026-01-01T00:00:00Z

description

string | null

Optional internal description.

validTo

string | null · date-time

Optional end of the validity window.

Example: 2026-12-31T23:59:59Z

The created revenue-share policy

RevenueSharePolicy

code

string · required

Stable code identifying the policy.

Example: P-ACME-3

name

string · required

Human-readable name.

Example: Fleet 85/15

kind

string · enum · required

Who the revenue is shared between.

Enum values:

team_to_team

operator_to_team

Example: operator_to_team

seller

string · enum · required

Who sells the electricity.

Enum values:

cpo

site_owner

Example: cpo

policyType

string · enum · required

How the share is measured.

Enum values:

percentage

per_kwh

Example: percentage

policyValue

number · required

The share value: a percentage of net, or an amount per kWh.

Example: 15

moneyFlow

string · enum · required

How the settled share reaches the recipient.

Enum values:

wallet_live

wallet_monthly

external

Example: wallet_live

status

string · enum · required

Lifecycle status.

Enum values:

Draft

Active

Example: Active

description

string | null

Optional internal description.

version

integer · int32

Policy version.

Example: 1

validFrom

string | null · date-time

Start of the validity window.

Example: 2026-01-01T00:00:00Z

validTo

string | null · date-time

End of the validity window.

Example: 2026-12-31T23:59:59Z

createdAt

string | null · date-time

Creation timestamp.

updatedAt

string | null · date-time

Last update timestamp.

deletedAt

string | null · date-time

Soft-delete timestamp, null when the policy is not deleted.

POST/api/v1/revenue-share/policies

curl https://partner-api.monta.com/api/v1/revenue-share/policies \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Fleet 85/15",
  "description": "description",
  "kind": "operator_to_team",
  "seller": "cpo",
  "policyType": "percentage",
  "policyValue": 15,
  "moneyFlow": "wallet_live",
  "validFrom": "2026-01-01T00:00:00Z",
  "validTo": "2026-12-31T23:59:59Z"
}'

Example Request Body

{
  "name": "Fleet 85/15",
  "description": "description",
  "kind": "operator_to_team",
  "seller": "cpo",
  "policyType": "percentage",
  "policyValue": 15,
  "moneyFlow": "wallet_live",
  "validFrom": "2026-01-01T00:00:00Z",
  "validTo": "2026-12-31T23:59:59Z"
}

json

Example Responses

{
  "code": "P-ACME-3",
  "name": "Fleet 85/15",
  "description": "description",
  "kind": "operator_to_team",
  "seller": "cpo",
  "policyType": "percentage",
  "policyValue": 15,
  "moneyFlow": "wallet_live",
  "status": "Active",
  "version": 1,
  "validFrom": "2026-01-01T00:00:00Z",
  "validTo": "2026-12-31T23:59:59Z",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "deletedAt": "2024-08-25T15:00:00Z"
}

json

application/json

GET

https://partner-api.monta.com

/api/v1/revenue-share/policies/{code}

Required scope: revenue-share:read

code

string · required

includeDeleted

boolean | null

Revenue-share policy with the provided code

RevenueSharePolicy

code

string · required

Stable code identifying the policy.

Example: P-ACME-3

name

string · required

Human-readable name.

Example: Fleet 85/15

kind

string · enum · required

Who the revenue is shared between.

Enum values:

team_to_team

operator_to_team

Example: operator_to_team

seller

string · enum · required

Who sells the electricity.

Enum values:

cpo

site_owner

Example: cpo

policyType

string · enum · required

How the share is measured.

Enum values:

percentage

per_kwh

Example: percentage

policyValue

number · required

The share value: a percentage of net, or an amount per kWh.

Example: 15

moneyFlow

string · enum · required

How the settled share reaches the recipient.

Enum values:

wallet_live

wallet_monthly

external

Example: wallet_live

status

string · enum · required

Lifecycle status.

Enum values:

Draft

Active

Example: Active

description

string | null

Optional internal description.

version

integer · int32

Policy version.

Example: 1

validFrom

string | null · date-time

Start of the validity window.

Example: 2026-01-01T00:00:00Z

validTo

string | null · date-time

End of the validity window.

Example: 2026-12-31T23:59:59Z

createdAt

string | null · date-time

Creation timestamp.

updatedAt

string | null · date-time

Last update timestamp.

deletedAt

string | null · date-time

Soft-delete timestamp, null when the policy is not deleted.

PATCH

https://partner-api.monta.com

/api/v1/revenue-share/policies/{code}

Required scope: revenue-share:write. Updating an active policy creates a new version.

code

string · required

UpdateRevenueSharePolicy

name

string | null · pattern: .*\S.*

Human-readable name.

description

string | null

Optional internal description.

policyValue

number | null · min: 0

The share value.

moneyFlow

string · enum

How the settled share reaches the recipient.

Enum values:

wallet_live

wallet_monthly

external

validFrom

string | null · date-time

Start of the validity window.

validTo

string | null · date-time

End of the validity window.

The updated revenue-share policy

RevenueSharePolicy

code

string · required

Stable code identifying the policy.

Example: P-ACME-3

name

string · required

Human-readable name.

Example: Fleet 85/15

kind

string · enum · required

Who the revenue is shared between.

Enum values:

team_to_team

operator_to_team

Example: operator_to_team

seller

string · enum · required

Who sells the electricity.

Enum values:

cpo

site_owner

Example: cpo

policyType

string · enum · required

How the share is measured.

Enum values:

percentage

per_kwh

Example: percentage

policyValue

number · required

The share value: a percentage of net, or an amount per kWh.

Example: 15

moneyFlow

string · enum · required

How the settled share reaches the recipient.

Enum values:

wallet_live

wallet_monthly

external

Example: wallet_live

status

string · enum · required

Lifecycle status.

Enum values:

Draft

Active

Example: Active

description

string | null

Optional internal description.

version

integer · int32

Policy version.

Example: 1

validFrom

string | null · date-time

Start of the validity window.

Example: 2026-01-01T00:00:00Z

validTo

string | null · date-time

End of the validity window.

Example: 2026-12-31T23:59:59Z

createdAt

string | null · date-time

Creation timestamp.

updatedAt

string | null · date-time

Last update timestamp.

deletedAt

string | null · date-time

Soft-delete timestamp, null when the policy is not deleted.

PATCH/api/v1/revenue-share/policies/{code}

curl https://partner-api.monta.com/api/v1/revenue-share/policies/:code \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "description": "description",
  "policyValue": 0,
  "moneyFlow": "wallet_live",
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "name": "name",
  "description": "description",
  "policyValue": 0,
  "moneyFlow": "wallet_live",
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "code": "P-ACME-3",
  "name": "Fleet 85/15",
  "description": "description",
  "kind": "operator_to_team",
  "seller": "cpo",
  "policyType": "percentage",
  "policyValue": 15,
  "moneyFlow": "wallet_live",
  "status": "Active",
  "version": 1,
  "validFrom": "2026-01-01T00:00:00Z",
  "validTo": "2026-12-31T23:59:59Z",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "deletedAt": "2024-08-25T15:00:00Z"
}

json

application/json

DELETE

https://partner-api.monta.com

/api/v1/revenue-share/policies/{code}

Required scope: revenue-share:delete

code

string · required

The revenue-share policy was deleted

No data returned

POST

https://partner-api.monta.com

/api/v1/revenue-share/policies/{code}/activate

Required scope: revenue-share:write.

code

string · required

The activated revenue-share policy

RevenueSharePolicy

code

string · required

Stable code identifying the policy.

Example: P-ACME-3

name

string · required

Human-readable name.

Example: Fleet 85/15

kind

string · enum · required

Who the revenue is shared between.

Enum values:

team_to_team

operator_to_team

Example: operator_to_team

seller

string · enum · required

Who sells the electricity.

Enum values:

cpo

site_owner

Example: cpo

policyType

string · enum · required

How the share is measured.

Enum values:

percentage

per_kwh

Example: percentage

policyValue

number · required

The share value: a percentage of net, or an amount per kWh.

Example: 15

moneyFlow

string · enum · required

How the settled share reaches the recipient.

Enum values:

wallet_live

wallet_monthly

external

Example: wallet_live

status

string · enum · required

Lifecycle status.

Enum values:

Draft

Active

Example: Active

description

string | null

Optional internal description.

version

integer · int32

Policy version.

Example: 1

validFrom

string | null · date-time

Start of the validity window.

Example: 2026-01-01T00:00:00Z

validTo

string | null · date-time

End of the validity window.

Example: 2026-12-31T23:59:59Z

createdAt

string | null · date-time

Creation timestamp.

updatedAt

string | null · date-time

Last update timestamp.

deletedAt

string | null · date-time

Soft-delete timestamp, null when the policy is not deleted.

GET

https://partner-api.monta.com

/api/v1/revenue-share/settlements

Required scope: revenue-share:read

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

agreementCode

string | null

Filter settlements by the agreement they belong to.

Example: A-ACME-1

status

string · enum

Filter by lifecycle status.

Enum values:

Pending

Settled

Failed

Other

Example: Settled

periodFrom

string | null · date-time

Return settlements whose period starts on or after this timestamp (ISO 8601, e.g. 2026-01-01T00:00:00Z).

Example: 2026-01-01T00:00:00Z

periodTo

string | null · date-time

Return settlements whose period ends on or before this timestamp (ISO 8601, e.g. 2026-01-31T23:59:59Z).

Example: 2026-01-31T23:59:59Z

Revenue-share settlements matching the filters

OffsetBasedResponse_51

RevenueShareSettlement[] · required

MontaPage.Meta · required

GET/api/v1/revenue-share/settlements

curl https://partner-api.monta.com/api/v1/revenue-share/settlements \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "100",
      "agreementCode": "A-ACME-1",
      "status": "Settled",
      "periodStart": "2026-01-01T00:00:00Z",
      "periodEnd": "2026-01-31T23:59:59Z",
      "currency": "EUR",
      "totalShareAmount": 125.5,
      "totalTaxAmount": 25.1,
      "walletTransactionId": "walletTransactionId",
      "attempts": 1,
      "lastAttemptAt": "2024-08-25T15:00:00Z",
      "settledAt": "2024-08-25T15:00:00Z",
      "errorReason": "errorReason",
      "createdAt": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Reports Schedules

Revenue Share

List revenue-share agreements

List revenue-share agreements › query Parameters

List revenue-share agreements › Responses

Apply a revenue-share policy to a team pair

Apply a revenue-share policy to a team pair › Headers

Apply a revenue-share policy to a team pair › Request Body

Apply a revenue-share policy to a team pair › Responses

Retrieve a single revenue-share agreement

Retrieve a single revenue-share agreement › path Parameters

Retrieve a single revenue-share agreement › Responses

Update a revenue-share agreement

Update a revenue-share agreement › path Parameters

Update a revenue-share agreement › Request Body

Update a revenue-share agreement › Responses

Delete a revenue-share agreement

Delete a revenue-share agreement › path Parameters

Delete a revenue-share agreement › Responses

Pause a revenue-share agreement

Pause a revenue-share agreement › path Parameters

Pause a revenue-share agreement › Responses

Resume a paused revenue-share agreement

Resume a paused revenue-share agreement › path Parameters

Resume a paused revenue-share agreement › Responses

List revenue-share calculations

List revenue-share calculations › query Parameters

List revenue-share calculations › Responses

List revenue-share policies

List revenue-share policies › query Parameters

List revenue-share policies › Responses

Create a revenue-share policy

Create a revenue-share policy › Request Body

Create a revenue-share policy › Responses

Retrieve a single revenue-share policy

Retrieve a single revenue-share policy › path Parameters

Retrieve a single revenue-share policy › query Parameters

Retrieve a single revenue-share policy › Responses

Update a revenue-share policy

Update a revenue-share policy › path Parameters

Update a revenue-share policy › Request Body

Update a revenue-share policy › Responses

Delete a revenue-share policy

Delete a revenue-share policy › path Parameters

Delete a revenue-share policy › Responses

Activate a revenue-share policy

Activate a revenue-share policy › path Parameters

Activate a revenue-share policy › Responses

List revenue-share settlements

List revenue-share settlements › query Parameters

List revenue-share settlements › Responses