Skip to main content

Create Sales Summary

POST 

https://api.bookkeep.com/v1/journal_entries

Create a sales summary journal entry to record daily sales activity.

Request

Body

    template stringrequired

    Possible values: [bookkeep_sales_summary]

    Default value: bookkeep_sales_summary

    Must be set to 'bookkeep_sales_summary'

    external_id stringrequired

    A unique identifier for this journal entry from your system

    date daterequired

    The date of the journal entry

    docnumber stringrequired

    Document number for the journal entry

    memo stringrequired

    Optional memo for the journal entry

    currency stringrequired

    Currency code (e.g. USD)

    gross_sales_credit object

    Breakdown of gross sales by category

    property name* floatrequired
    discounts_debit floatrequired

    Total discounts amount

    refunds_debit floatrequired

    Total refunds amount

    sales_tax_collected_credit floatrequired

    Sales tax collected

    sales_tax_withheld_debit floatrequired

    Sales tax withheld

    gift_card_sales_credit floatrequired

    Gift card sales amount

    gift_tender_total_debit floatrequired

    Gift card tender amount

    gratuity_collected_credit floatrequired

    Gratuity collected

    fees_debit floatrequired

    Total fees

    payments_debit object

    Breakdown of payments by type

    property name* floatrequired
    payments_cash_debit floatrequired

    Cash payments amount

    ar_credits_posted_credit floatrequired

    AR credits posted

    ar_charges_posted_debit floatrequired

    AR charges posted

    misc_credits_credit floatrequired

    Miscellaneous credits

    misc_debits_debit floatrequired

    Miscellaneous debits

    summarized_net_sales floatrequired

    Net sales (gross_sales_credit - discounts_debit - refunds_debit)

    transactions_summarized_count integerrequired

    Number of transactions included in this summary

    source_system stringrequired

    Identifier for the source system

    source_system_display_name stringrequired

    Display name for the source system

Responses

Sales summary journal entry created successfully

Schema
    id stringrequired

    The ID of the created journal entry

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 -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"
}'
Request Collapse all
Base URL
https://api.bookkeep.com
Auth
Body
{
  "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"
}
ResponseClear

Click the Send API Request button above and see the response here!