> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Get the books > The books for a period: the profit and loss line by line beside the period before, where the buyers were, and what each payment method took in. Gross sales are at the prices before any sale, and what sales, discounts, refunds and chargebacks took off is a line each; affiliate commission is a cost of sales. Tax collected is not income and is in none of it but the tax report. A store makes at most 20 reports every 10 minutes, counting this one, the other report, their files and the dashboard's Generate Report together: after that the answer is 429. Refused with `business_details_required` until the store has its business details. Needs the `finance.read` permission (Read Finance). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key. ## OpenAPI ````yaml /api-reference/openapi.json get /stores/{storeId}/finance/accounting openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/finance/accounting: get: tags: - Finance summary: Get the books description: >- The books for a period: the profit and loss line by line beside the period before, where the buyers were, and what each payment method took in. Gross sales are at the prices before any sale, and what sales, discounts, refunds and chargebacks took off is a line each; affiliate commission is a cost of sales. Tax collected is not income and is in none of it but the tax report. A store makes at most 20 reports every 10 minutes, counting this one, the other report, their files and the dashboard's Generate Report together: after that the answer is 429. Refused with `business_details_required` until the store has its business details. Needs the `finance.read` permission (Read Finance). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key. operationId: finance.accounting parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string - name: range in: query required: false description: The period. schema: type: string enum: - today - yesterday - 7d - 30d - this_week - last_week - this_month - last_month - this_year default: this_month - name: from in: query required: false description: >- The first day of a period of your own, as `YYYY-MM-DD`. With `to`, in place of `range`. schema: type: string - name: to in: query required: false description: Its last day, as `YYYY-MM-DD`. schema: type: string - name: tz in: query required: false description: The time zone those days are in, as an IANA name. Left out, UTC. schema: type: string example: Europe/Berlin responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: period: type: object properties: from: type: string to: type: string label: type: string previousFrom: type: string previousTo: type: string previousLabel: type: string currency: type: string business: type: array items: type: string lines: type: array items: type: object properties: kind: type: string label: type: string tax: type: object properties: now: type: integer previous: type: integer now: type: object properties: netSales: type: number grossProfit: type: number expenses: type: integer profit: type: number margin: type: number previous: type: object properties: netSales: type: integer grossProfit: type: integer expenses: type: integer profit: type: integer margin: nullable: true checks: type: array items: type: object properties: text: type: string href: type: string action: type: string counts: type: object properties: orders: type: integer expenses: type: integer countries: type: array items: type: object properties: country: type: string name: type: string orders: type: integer amount: type: integer share: type: integer methods: type: array items: type: object properties: provider: type: string name: type: string orders: type: integer volume: type: integer fees: type: number rated: type: boolean net: type: number taxReport: type: object properties: rows: type: - array - object taxable: type: integer tax: type: integer example: success: true message: null code: null data: period: from: '2026-10-01' to: '2026-10-22' label: 1 to 22 October 2026 previousFrom: '2026-09-01' previousTo: '2026-09-22' previousLabel: 1 to 22 September 2026 currency: USD business: - Northwind Keys Ltd - Germany lines: - kind: group label: Income - kind: line label: Gross sales note: 5 orders now: 88.97 previous: 0 estimate: false tax: now: 0 previous: 0 now: netSales: 78.98 grossProfit: 77.26 expenses: 0 profit: 77.26 margin: 97.8 previous: netSales: 0 grossProfit: 0 expenses: 0 profit: 0 margin: null checks: - text: 4 items were sold with no cost set href: /finance/reports action: Set costs - text: No fee rate is set for Custom c009621ccc3e9d74, PayPal href: /finance/reports action: Set rates counts: orders: 5 expenses: 0 countries: - country: DE name: Germany orders: 1 amount: 49 share: 62 - country: '' name: Not known orders: 3 amount: 29.98 share: 38 methods: - provider: stripe name: Stripe orders: 1 volume: 49 fees: 1.72 rated: true net: 47.28 - provider: paypal name: PayPal orders: 1 volume: 10 fees: 0 rated: false net: 10 taxReport: rows: [] taxable: 0 tax: 0 '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.finance.accounting(); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->finance->accounting(); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.finance.accounting() components: responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.