Create Sales Summary
POSThttps://api.bookkeep.com/v1/journal_entries
Create a sales summary journal entry to record daily sales activity.
Request
- application/json
Body
Possible values: [bookkeep_sales_summary
]
Default value: bookkeep_sales_summary
Must be set to 'bookkeep_sales_summary'
A unique identifier for this journal entry from your system
The date of the journal entry
Document number for the journal entry
Optional memo for the journal entry
Currency code (e.g. USD)
gross_sales_credit object
Total discounts amount
Total refunds amount
Sales tax collected
Sales tax withheld
Gift card sales amount
Gift card tender amount
Gratuity collected
Total fees
payments_debit object
Cash payments amount
AR credits posted
AR charges posted
Miscellaneous credits
Miscellaneous debits
Net sales (gross_sales_credit - discounts_debit - refunds_debit)
Number of transactions included in this summary
Identifier for the source system
Display name for the source system
Responses
- 200
- 400
Sales summary journal entry created successfully
- application/json
- Schema
- Example (from schema)
Schema
The ID of the created journal entry
{
"id": "string"
}
Invalid request error
- application/json
- Schema
- Example (from schema)
Schema
error object
{
"error": {
"message": "Invalid request parameters",
"type": "invalid_request_error"
}
}
Authorization: http
name: basic_authtype: httpdescription: The Bookkeep API uses API keys to authenticate requests. You can view and manage your API keys in the [Bookkeep Developer Dashboard](https://app.bookkeep.com/developers/api_keys). Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your Publishable key as the basic auth username value and your Secret key as the basic auth password value. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ```curl curl -L -X GET 'https://api.bookkeep.com/v1/entities' \ -H 'Authorization: Basic ZGlsaXAuYmFpcmFnaUBib29ra2VlcC5jbzpXLlM4NVZGbkJyeEY2QmI=' ``` scheme: basic
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X POST 'https://api.bookkeep.com/v1/journal_entries' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"template": "bookkeep_sales_summary",
"external_id": "string",
"date": "2025-03-18",
"docnumber": "string",
"memo": "string",
"currency": "string",
"gross_sales_credit": {},
"discounts_debit": 0,
"refunds_debit": 0,
"sales_tax_collected_credit": 0,
"sales_tax_withheld_debit": 0,
"gift_card_sales_credit": 0,
"gift_tender_total_debit": 0,
"gratuity_collected_credit": 0,
"fees_debit": 0,
"payments_debit": {},
"payments_cash_debit": 0,
"ar_credits_posted_credit": 0,
"ar_charges_posted_debit": 0,
"misc_credits_credit": 0,
"misc_debits_debit": 0,
"summarized_net_sales": 0,
"transactions_summarized_count": 0,
"source_system": "string",
"source_system_display_name": "string"
}'