SharedBudgetQueryResponse

The response object for a budget order query.

Declaration

object SharedBudgetQueryResponse

Properties

Name	Type	Description
`result`	[`SharedBudget`]	Array of `SharedBudget` objects matching the query filters. Omitted entirely on failure rather than returned as `null`. Read-only.
`pagination`	`QueryPaginationResult`	Pagination metadata for the result set, including `pageSize` (number of results per page), `offset` (zero-based offset of the first result), and `totalCount` (total number of matching records, only populated when the request sends `fetchTotalCount: true`). Read-only.
`error`	`Error`	Error details if the request failed. Omitted entirely on success and never returned as `"error": null`. Only appears when the operation fails. See Error. Read-only.

Discussion

The budget order query endpoint returns SharedBudgetQueryResponse, which contains the filtered, sorted, and paginated set of SharedBudget objects matching the request. The result array holds the matching records. To scope results by ad account ID, status, or specific budget IDs, use the QueryRequest body with filters.

Example

{
  "result": [
    {
      "id": 777890001,
      "name": "AwayFinder - Q3 2025 Budget",
      "startTime": "2025-07-01T00:00:00.000",
      "endTime": "2025-09-30T23:59:59.000",
      "value": {
        "amount": "20000.00",
        "currency": "USD"
      },
      "adAccountIds": [
        123456789
      ],
      "orgId": 555666777,
      "systemStatus": "ACTIVE",
      "systemStatusReasons": [],
      "invoiceDetail": {
        "primaryBuyerName": "Jordan Lee",
        "primaryBuyerEmail": "jordan.lee@awayfinder.com",
        "billingEmail": "billing@awayfinder.com",
        "clientName": "AwayFinder Inc.",
        "orderNumber": "PO-2025-Q3"
      },
      "creationTime": "2025-06-01T10:00:00.000",
      "modificationTime": "2025-06-01T10:00:00.000",
      "deleted": false
    }
  ],
  "pagination": {
    "pageSize": 20,
    "offset": 0,
    "totalCount": 1
  }
}