Balances Get Api V1External Account Balances By Account Id
GET {{baseUrl}}/2024-01/retail-media/accounts/:account-id/balances?limitToId=<string>&limitToId=<string>&pageIndex=0&pageSize=25
Get page of balances for the given accountId.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limitToId | string | The ids that you would like to limit your result set to | |
limitToId | string | The ids that you would like to limit your result set to | |
pageIndex | number | The 0 indexed page index you would like to receive given the page size | |
pageSize | number | The maximum number of items you would like to receive in this request |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"metadata":{"currentPageSize":"\u003cinteger\u003e","currentPageIndex":"\u003cinteger\u003e","totalItemsAcrossAllPages":"\u003clong\u003e","totalPages":"\u003clong\u003e","nextPage":"\u003cstring\u003e","previousPage":"\u003cstring\u003e"},"data":[{"attributes":{"name":"\u003cstring\u003e","poNumber":"\u003cstring\u003e","memo":"\u003cstring\u003e","deposited":"\u003cnumber\u003e","spent":"\u003cnumber\u003e","remaining":"\u003cnumber\u003e","startDate":"\u003cdate\u003e","endDate":"\u003cdate\u003e","status":"active","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","balanceType":"uncapped","salesForceId":"\u003cstring\u003e","spendType":"OffsiteAwareness","privateMarketBillingType":"Unknown"},"id":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"attributes":{"name":"\u003cstring\u003e","poNumber":"\u003cstring\u003e","memo":"\u003cstring\u003e","deposited":"\u003cnumber\u003e","spent":"\u003cnumber\u003e","remaining":"\u003cnumber\u003e","startDate":"\u003cdate\u003e","endDate":"\u003cdate\u003e","status":"active","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","balanceType":"capped","salesForceId":"\u003cstring\u003e","spendType":"Onsite","privateMarketBillingType":"BillByRetailer"},"id":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"warnings":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"quota","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"qui_f_7":"\u003cstring\u003e","pariatur_aa8":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"access-control","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"cillumc":"\u003cstring\u003e","laboris_f":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"errors":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"quota","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"est7":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"deprecation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"consequat_bc8":"\u003cstring\u003e","consectetur4b8":"\u003cstring\u003e","ut7cf":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}