---
title: "Network Finances API endpoints"
description: "Endpoint reference for the Network Finances tag (6 endpoints): Network-level financial management — advertiser payments, publisher payouts, and balance tracking"
type: "reference"
audience: [network-manager, admin]
keywords: [api, rest, endpoints, network, finances]
---

Fetch the complete documentation index at: https://epom.com/ad-server/docs/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.

# Network Finances API endpoints

Network-level financial management — advertiser payments, publisher payouts, and balance tracking. 6 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see [REST API overview](https://epom.com/ad-server/docs/api.md). Parameters marked `form` go in an `application/x-www-form-urlencoded` request body.

### GET /rest-api/advertiser/{advertiserId}/payments.do

[Request examples](https://epom.com/ad-server/docs/api/network-finances/get-advertiser-payments.md)

List advertiser payments.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `advertiserId` | path | integer | yes | Advertiser ID |
| `balanceMonth` | query | string | no | Month whose balance record 'balance' reports, yyyy-MM (2010-01 to 2050-12). The current month when omitted. |
| `limit` | query | integer | no | Page size, 1 to 1000 |
| `month` | query | array&lt;integer&gt; | no | Only payments of these months (1-12) |
| `start` | query | integer | no | 0-based offset of the first payment to return |
| `year` | query | array&lt;integer&gt; | no | Only payments of these years |

**Responses:** `200` — {success, advertiserId, advertiserName, total, start, limit, totalAmount, payments:[{paymentId, date (yyyy-MM-dd), year, month, amount, comment}], balance:{year, month, startBalance, charges, payments, endOfMonthBalance}|null} · `404` — No such advertiser, or it is not shared with the caller. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### POST /rest-api/advertiser/{advertiserId}/payments.do

[Request examples](https://epom.com/ad-server/docs/api/network-finances/post-advertiser-payments.md)

Add an advertiser payment.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `advertiserId` | path | integer | yes | Advertiser ID |
| `amount` | form | number | yes | Amount paid, in the network's currency; greater than 0 and at most 9999999.999999 |
| `comment` | form | string | no | Optional memo, up to 200 characters |
| `date` | form | string | no | Payment date, yyyy-MM-dd between 2010 and 2050. Today when omitted. |

**Responses:** `200` — Payment booked: {success, advertiserId, payment:{paymentId, date, year, month, amount, comment}} · `404` — No such advertiser, or it is not shared with the caller. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### DELETE /rest-api/advertiser/{advertiserId}/payments/{paymentId}.do

[Request examples](https://epom.com/ad-server/docs/api/network-finances/delete-advertiser-payments.md)

Delete an advertiser payment.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `advertiserId` | path | integer | yes | Advertiser ID |
| `paymentId` | path | integer | yes | Payment ID, as returned by the payment list |

**Responses:** `200` — Payment removed: {success, advertiserId, paymentId} · `404` — No such advertiser or payment, the payment belongs to another advertiser, or the advertiser is not shared with the caller. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### GET /rest-api/site/{siteId}/payouts.do

[Request examples](https://epom.com/ad-server/docs/api/network-finances/get-site-payouts.md)

List publisher payouts.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `siteId` | path | integer | yes | Site ID |
| `balanceMonth` | query | string | no | Month whose balance record 'balance' reports, yyyy-MM (2010-01 to 2050-12). The current month when omitted. |
| `limit` | query | integer | no | Page size, 1 to 1000 |
| `month` | query | array&lt;integer&gt; | no | Only payments of these months (1-12) |
| `start` | query | integer | no | 0-based offset of the first payment to return |
| `year` | query | array&lt;integer&gt; | no | Only payments of these years |

**Responses:** `200` — {success, siteId, siteName, total, start, limit, totalAmount, payouts:[{paymentId, date (yyyy-MM-dd), year, month, amount, comment}], balance:{year, month, balance, paidOut, toBePaid}|null} · `404` — No such site, or it is not shared with the caller. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### POST /rest-api/site/{siteId}/payouts.do

[Request examples](https://epom.com/ad-server/docs/api/network-finances/post-site-payouts.md)

Add a publisher payout.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `siteId` | path | integer | yes | Site ID |
| `amount` | form | number | yes | Amount paid, in the network's currency; greater than 0 and at most 9999999.999999 |
| `comment` | form | string | no | Optional memo, up to 200 characters |
| `date` | form | string | no | Payment date, yyyy-MM-dd between 2010 and 2050. Today when omitted. |

**Responses:** `200` — Payout booked: {success, siteId, payout:{paymentId, date, year, month, amount, comment}} · `404` — No such site, or it is not shared with the caller. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### DELETE /rest-api/site/{siteId}/payouts/{paymentId}.do

[Request examples](https://epom.com/ad-server/docs/api/network-finances/delete-site-payouts.md)

Delete a publisher payout.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `siteId` | path | integer | yes | Site ID |
| `paymentId` | path | integer | yes | Payout ID, as returned by the payout list |

**Responses:** `200` — Payout removed: {success, siteId, paymentId} · `404` — No such site or payout, the payout belongs to another site, or the site is not shared with the caller. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

## Related

- [REST API overview](https://epom.com/ad-server/docs/api.md) — authentication and conventions
- [API endpoint reference by tag](https://epom.com/ad-server/docs/api/endpoints.md)

<!-- Generated from the OpenAPI spec. Do not edit by hand. -->