openapi: 3.2.0 info: description: '# Getting Started ## Document Purpose and Scope The Scale REST API endpoints are technically described in this document.' title: Scale REST Check Balance API version: '9.1' servers: - url: http://{env}-svc-core.amcsplatform.com/scale/api/ tags: - name: Check Balance paths: /integrator/checkBalances: get: tags: - Check Balance summary: Find with Filters description: '| Property | Description | | ---------------------------------------------------- | ---------------------------------------------------------------------------------- | | GUID | The Site order GUID. Filterable. | | CreditBalanceCheck | If they can start a new weighing based on Credit balance |' operationId: CheckBalance_GetCollection parameters: - name: filter in: query required: false schema: type: string - name: search in: query required: false schema: type: string - name: order in: query required: false schema: type: string - name: max in: query required: false schema: type: integer format: int32 - name: page in: query required: false schema: type: integer format: int32 - name: includeCount in: query required: false schema: type: boolean - name: includeDeleted in: query required: false schema: type: boolean - name: links in: query required: false schema: type: string - name: udf in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ApiResourceResultCollection_ApiCheckBalanceResource' components: schemas: ApiResourceResultCollectionExtra: type: object properties: count: format: int32 type: integer ApiResourceResultCollection_ApiCheckBalanceResource: type: object properties: resource: type: array items: $ref: '#/components/schemas/ApiCheckBalanceResource' extra: $ref: '#/components/schemas/ApiResourceResultCollectionExtra' errors: $ref: '#/components/schemas/ApiResourceErrors' status: $ref: '#/components/schemas/ApiResourceStatus' ApiResourceStatus: type: object properties: id: format: int32 type: integer isSuccess: type: boolean ApiResourceErrors: type: object properties: errors: type: string ApiCheckBalanceResource: type: object properties: CreditBalanceCheck: type: boolean SiteOrderGuid: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 GUID: format: uuid type: string example: 00000000-0000-0000-0000-000000000000