--- title: "Search for balances" method: GET path: "/posbalances" tags: ["POSBalances"] --- # Search for balances `GET /posbalances` ## Request - Base URL: `https://api.c1st.com/api` - URL: `https://api.c1st.com/api/posbalances` - Auth: HTTP bearer Get balances. Balances are readonly and can only be created via Customers 1st app ## Query parameters - `paginationStart` integer - `paginationPageLength` integer - `sortOrder` -1 | 1 - `sortField` string - `userId` integer - `cashRegisterId` integer - `toDate` string - `fromDate` string ## Response `200` Ok - SearchPOSBalanceResponse: The representation of a pos balance search. - `content` POSBalance[] - `id` integer, nullable: A unique payment ID - `balance_no` integer, nullable: The current balance number - `date` string: The date of the balance. Defaults to current date - `enddate` string, nullable: The date of when the balance has ended - `startdate` string, nullable: The date of when the balance has started - `numpayments` integer: The number of payments in the balance. - `cashstart` number, double: The cash in the register at the start of the balance. - `cashcounted` number, double: The counted cash in the cash register - `expense` number, double, nullable: The expense for the day - `cashrevenue` number, double, nullable: Revenue in cash - `cashtobank` number, double: Cash taken out of the register and put in the bank. - `cashdifference` number, double - `cashrounding` number, double, nullable - `totalrevenue` number, double: The total revenue - `totalrevenue_ex_vat` number, double: The total revenue excluding VAT - `cashregistertitle` string, nullable: The name of the cash register (if any) - `cashregisterid` integer, nullable: Id of the cash register attached to the balance - `last_synced_at` string, nullable: The datetime of the last posbalance sync (if any) - `lastdinerosync` string, nullable: DEPRECATED: use last_synced_at instead. The datetime of the last Dinero sync (if any) - `lasteconomicsync` string, nullable: DEPRECATED: use last_synced_at instead. The datetime of the last e-conomic sync (if any) - `userid` integer, nullable - `paymenttypes` object[] - `paymenttypeid` integer, nullable: The id of the payment type (if present) - `title` string: The type of payment - `amount` number, double: The amount of the payment type. - `card_fees` number, double: The amount of fees paid. - `cash` boolean: Returns whether or not the payment type is cash-based. - `bamdesk_messageid` integer, nullable: The id for the Worldline card-terminal if it is used. Null otherwise. - `accountno` string, nullable: The account where the payment has been posted. If not applicable, it will be null. - `currency` string, nullable: The currency associated with the payment type - `giftcardtype` string, nullable: The giftcard type if a giftcard is used. Null otherwise. - `provider` string, nullable - `payouts` object[] - `date` string, nullable: The date of the payout - `exported_at` string, nullable: The date the payout was exported to the accounting system - `reference` string: The payout reference - `amount` number, double: The amount of the payment type. - `currency` string: The currency of the payout - `giftcardissued` number, double, nullable: The total amount issued on giftcards. - `giftcardused` number, double, nullable: The total amount spent via giftcards. - `returnsum` number, double: The total sum of returned articles - `salesum` number, double: The total sum of sold articles - `invoices` integer, nullable: The number of payments paid with invoices - `invoicesum` number, double, nullable: The sum of payments paid with invoices - `economicinvoicesum` number, double, nullable: The sum of payments paid with economic invoices. Deprecated, use invoicesum instead - `totalsenttobookkeeping` number, double: Total sent to e-conomic, excluding the economicinvoicesum - `totalvat` number, double: The total VAT - `totalvatbypercentage` VATByPercentage[]: VAT by each percentage - `vat_type_name` string, nullable - `revenue_account_no` string, nullable - `vat_account_no` string, nullable - `percentage` number, double - `amount` number, double - `revenue_ex_vat` number, double - `revenue_incl_vat` number, double - `totalcostprice` number, double, nullable: The total cost price - `totalcostpricestockonly` number, double, nullable: The total cost price for products with tracked stock only - `note` string, nullable: A text note - `customerpaymentsum` number, double, nullable: The sum of the customerpayments - `stockvalue` number, double, nullable: Stock value of the store's inventory at the time of the POS balance - `secondhandprofitsum` number, nullable: Sum of profit from selling secondhand products - `secondhandcostpricesum` number, nullable: The sum of the difference between the price of the product sold and the profit for the product - `secondhandcostpricesumstockonly` number, nullable: The sum of the difference between the price of the product sold and the profit for the product for products with tracked stock only - `secondhandreturnsum` number, nullable: Sum of all products that has been returned as a second hand product - `secondhandreturnsumstockonly` number, nullable: Sum of all products that has been returned as a second hand product for the product for products with tracked stock only - `secondhandinvoicesum` number, nullable: Sum of all products that are second hand - `totalstocktransactionsrest` number, nullable: Sum of all stocktransactions that are not inventory count adjustments and that are not in payment or stocktransactionlist - `totalstocktransactionsinventorycount` number, nullable: Sum of all stocktransactions that are inventory count adjustments - `totalstocktransactionsrestincludingnegative` number, nullable: Sum of all stocktransactions that are not inventory count adjustments and that are not in payment or stocktransactionlist including movements between negative stock values - `totalstocktransactionsinventorycountincludingnegative` number, nullable: Sum of all stocktransactions that are inventory count adjustments including movements between negative stock values - `startpaymentno` integer, nullable: The first payment no in this balance - `endpaymentno` integer, nullable: The last payment no in this balance - `number_of_products` integer: The total number of products sold - `number_of_services` integer: The total number of services sold - `number_of_return_sales` integer: The total number of return sales processed - `number_of_uncompleted_sales` integer: The total number of uncompleted sales - `total_discount` number, double: The total amount of discounts applied - `total_uncompleted_sales` number, double: The total value of uncompleted sales - `accumulated_sales` number, double: The accumulated grand total value of completed sales - `accumulated_returns` number, double: The accumulated grand total value of returns - `drawer_open_count` integer: The number of times the cash drawer was opened - `number_of_receipts` integer: The total number of receipts issued - `number_of_receipt_copies_printed` integer: The total number of receipt copies printed - `total_revenue_receipt_copies` number, double: The total sum amount for all receipt copies printed - `count` integer, nullable: The total number of items found by the query. - `hasMore` boolean: True if there are data to retrieve than the given page length --- [API](https://skmtc.dev/c1st/apis/customers-1st-api.md) - [All operations](https://skmtc.dev/c1st/apis/customers-1st-api/llms.txt) - [OpenAPI document](https://skmtc.dev/c1st/apis/customers-1st-api/revisions/4250bb326f2a?raw)