Skip to main content

Create Sales Summary

POST 
/v1/journal_entries

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

Notes:

  • Partners can request a source system name with associated Logo just email [email protected]
  • The date of the journal entry should be the date of the sales summary
  • All monetary amounts should be floats representing dollar amounts (or equivalent currency) rather than cents. $1.00 is 1.00, not a value in cents.
  • Any blank/null floats should be sent as 0.00. Empty string fields should be empty strings.
  • All _credits should equal _debits.
  • Optional memo and document number for reference
  • Object type fields allow you to add drop down subcategories with labels. Each of which will be added as a new line for mapping.
  • Not all fields are required. Only the top level fields are required.

Request​

Body

    template stringrequired

    Default value: bookkeep_sales_summary

    Must be set to 'bookkeep_sales_summary'

    entity_id stringrequired

    Unique identifier for the entity which you get from the URL when logged in to bookkeep or if you query for entity list. Usually an entity connected to one accounting platform in the case of QuickBooks or Xero.

    external_id stringrequired

    Default value: Location Name

    An immutable identifier for this sales channel from your system. Note that each location will create a separate mapping template. If this changes it will create a new mapping template. This will be used in the summary line to indicate the location name.

    source_system stringrequired

    Default value: bookkeep

    Identifier for the source system use 'bookkeep' for testing then request your own from [email protected]

    date daterequired

    The date of the journal entry should be the date of the sales summary using the format YYYY-MM-DD

    currency stringrequired

    Currency code (e.g. USD) 3 character currency code

    summarized_net_sales floatrequired

    Net sales calculated from the gross sales, discounts, and refunds etc.

    transactions_summarized_count integerrequired

    Number of transactions included in this summary

    docnumber stringrequired

    Document number for the journal entry which will override the default document number in QuickBooks

    memo stringrequired

    Optional memo for the journal entry that will pass through to the accounting platform so details can be added here regarding the summary information.

    gross_sales_credit object

    Breakdown of gross sales by category

    property name* floatrequired
    discounts_debit float

    Total discounts amount

    property name* floatrequired
    refunds_debit float

    Total refunds amount

    property name* floatrequired
    sales_tax_collected_credit float

    Sales tax collected

    property name* floatrequired
    sales_tax_withheld_debit float

    Sales tax withheld

    property name* floatrequired
    payments_debit object

    Breakdown of payments by type

    property name* floatrequired
    payments_cash_debit floatrequired

    Cash payments amount

    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

    ar_credits_posted_credit float

    AR credits posted

    property name* floatrequired
    ar_charges_posted_debit float

    AR charges posted

    property name* floatrequired
    misc_credits_credit float

    Miscellaneous credits

    property name* floatrequired
    misc_debits_debit float

    Miscellaneous debits

    property name* floatrequired

Responses​

Journal entry created successfully

Schema
    message stringrequired
    validation_summary object
    debit floatrequired
    credit floatrequired
    difference floatrequired
Loading...