Create Sales Summary

POST 
/v1/journal_entries

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

Request

application/json

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

200

Sales summary journal entry created successfully

application/json

Schema

Schema

id stringrequired

The ID of the created journal entry

Example (from schema)

{
  "id": "string"
}

400

Invalid request error

application/json

Schema

Schema

error object
message stringrequired
type stringrequired

Example (from schema)

{
  "error": {
    "message": "Invalid request parameters",
    "type": "invalid_request_error"
  }
}

Loading...