Balances Api Get Api202110External Account Balances By Account Id
GET {{baseUrl}}/2023-01/retail-media/accounts/:account-id/balances?limitToId=<string>&limitToId=<string>&pageIndex=<integer>&pageSize=<integer>
Gets page of balance objects for the given account id
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 | string | The 0 indexed page index you would like to receive given the page size | |
pageSize | string | 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":[{"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","status":"scheduled","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","endDate":"\u003cdate\u003e"}},{"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","status":"active","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","endDate":"\u003cdate\u003e"}}],"warnings":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"deprecation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"aliquip8f5":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"quota","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"sint090":"\u003cstring\u003e","elit_05":"\u003cstring\u003e","laborecb2":"\u003cstring\u003e","inb3":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"errors":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"access-control","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"inb5f":"\u003cstring\u003e","do763":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"authorization","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"commodo_01c":"\u003cstring\u003e","officia_38":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}