Payouts

Get paid payout breakdown

Returns the persisted calculation summary snapshot and invoiced line items for a paid payout. summary and engineTotal may be null for records created before snapshots were stored. invoiced amounts are in major currency units.

get/payouts/{id}/breakdown

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/payouts/{id}/breakdown
  • Auth: API key in header x-api-key

Path parameters

idstring required

Payout ID with orgpay_ prefix

Example:orgpay_RwmraAffhMt9

Response

OK

idstring required

Payout ID with orgpay_ prefix

customizedboolean required

Whether the invoice was customized away from the calculated total (the server-owned "Already paid" deductions of earlier partial payments do not count)

partialPaymentboolean required

Whether this payout is a partial payment toward a billing window still in progress (the calculation is then what the window had earned so far)

partialsDeductednumber required

Earnings of earlier partial payments this invoice deducts ("Already paid" lines), in major currency units; 0 when none

Example response

{
  "id": "orgpay_RwmraAffhMt9",
  "summary": {
    "metrics": {
      "perVideo": {
        "items": [
          {
            "platform": "facebook"
          }
        ]
      },
      "perCategory": [
        {
          "items": [
            {
              "platform": "facebook"
            }
          ]
        }
      ],
      "manuallyExcludedVideos": [
        {
          "platform": "facebook"
        }
      ],
      "conditionMisses": [
        {
          "items": [
            {
              "platform": "facebook",
              "creative": {
                "by": {
                  "platform": "facebook"
                }
              }
            }
          ]
        }
      ],
      "carriedVideos": [
        {
          "items": [
            {
              "platform": "facebook"
            }
          ]
        }
      ],
      "mergedCopies": [
        {
          "items": [
            {
              "platform": "facebook",
              "into": {
                "platform": "facebook"
              }
            }
          ]
        }
      ]
    },
    "settlement": {
      "separatelyPaidVideos": [
        {
          "platform": "facebook"
        }
      ],
      "placedVideos": [
        {
          "platform": "facebook"
        }
      ],
      "includedVideos": [
        {
          "platform": "facebook"
        }
      ],
      "carriedVideos": [
        {
          "platform": "facebook"
        }
      ],
      "priorCarriedVideos": [
        {
          "platform": "facebook"
        }
      ],
      "timeZone": "UTC"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.