--- title: "Get CRB sales" method: GET path: "/crbs/{crb_id}/sales" tags: ["Sales"] --- # Get CRB sales `GET /crbs/{crb_id}/sales` ## Request - Base URL: `https://sandbox-api.greencheckverified.com` - URL: `https://sandbox-api.greencheckverified.com/crbs/{crb_id}/sales` - Auth: API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `crb_id` string, required ## Query parameters - `start_date` string, required - `end_date` string, required - `limit` integer - `offset` integer - `customer_id` string - `pos_customer_id` string - `last_updated_from` string - `last_updated_to` string ## Response `200` Ok - PagedSales - `metadata` object, required - `total` integer, required - `count` string, required: Range of items returned - `data` union[], required - union - RetailSale - `id` string, uuid, required - `pos_sale_id` string, nullable, required: Sale ID in the POS system - `crb_id` string, uuid, required - `subtotal` number, double, nullable, required: Pre-tax dollar amount in cents - `total_discounts` number, double, nullable, required: Total discount amount in cents - `tax_paid` number, double, nullable, required: Tax amount in cents - `total_paid` number, double, nullable, required: Price + Tax in cents - `date` string, date-time, required - `local_date` string, required - `gc_created_date` string, date-time, required - `gc_updated_date` string, date-time, required - `transaction_type` 'sale' | 'return' | 'adjustment', required - `pos_name` 'Alleaves' | 'Apex Trading Wholesale' | 'Dutchie' | 'Dutchie Wholesale' | 'Cova' | 'Meadow' | 'MJ Freeway' | 'MJ Freeway Wholesale' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'Portal42' | 'Metrc S2S' | 'Metrc S2S Wholesale' | 'Flourish' | 'Flourish Wholesale' | 'Flowhub' | 'BioTrack' | 'BioTrack Wholesale' | 'Treez' | 'Blaze' | 'Quickbooks' | 'Sage Intacct' | 'Canix' | 'Brytemap' | 'POSaBIT' | 'Proteus420' | 'IndicaOnline' | 'Sweed' | 'Weave' | 'Jane' | 'Manual Upload Wholesale' | 'Cova Test Account' | 'Leaf Logix Test Account' | 'BioTrack Test Account' | 'Mj Freeway Test Account' | 'Treez IO Test Account' | 'Green Bits Test Account' | 'Manual Upload Retail' | 'SFTP Sales Retail' | 'SFTP Sales Wholesale' | 'Not Configured' | 'Unsupported' | 'CRBMonitor' | 'Plaid', required - `type` 'retail', required - `employee_id` string, nullable: Employee ID - `line_items` SaleLineItem[], required: Sale Line Items - `product_id` string, uuid, required - `pos_product_id` string, nullable, required: The product ID in the POS system - `product_name` string, nullable, required: Name in POS system - `num_units` number, double, nullable, required: Number of units bought - `price_per_unit` number, double, nullable, required: Price per individual unit - `grams` number, double, nullable, required: Weight of product in grams - `product_type` 'flower' | 'oil/concentrate' | 'edible' | 'other' | 'seedling' | 'seed' | 'liquid' | 'solid' | 'extract' | 'plant' | 'accessory' | 'marijuana_product' | 'topical' | 'edible_liquid', nullable, required - `cannabis_product` boolean, nullable, required: Whether product contains cannabis - `line_item_discounts` SaleDiscount[], required: Line item specific discounts - `flat_amount` number, double, nullable, required: Discount amount in cents - `pct_amount` number, double, nullable, required: Discount percentage as a real number - `name` string, nullable, required: Name of discount - `line_item_taxes` SaleTax[], required: Line item specific taxes - `flat_amount` number, double, nullable, required: Tax amount in cents - `pct_amount` number, double, nullable, required: Tax percentage as a real number - `name` string, nullable, required: Name of tax - `line_item_fees` SaleFee[], required: Line item specific fees - `fee_name` string, nullable, required: Name of the fee - `percent_amount` number, double, nullable, required: Fee percentage as a real number - `flat_amount` number, double, nullable, required: Flat amount of fee in cents - `included_in_subtotal` boolean, nullable, required: True if this fee's calculation is included in the subtotal - `discounts` SaleDiscount[], required: Sale Discounts - `flat_amount` number, double, nullable, required: Discount amount in cents - `pct_amount` number, double, nullable, required: Discount percentage as a real number - `name` string, nullable, required: Name of discount - `taxes` SaleTax[], required: Sale Taxes - `flat_amount` number, double, nullable, required: Tax amount in cents - `pct_amount` number, double, nullable, required: Tax percentage as a real number - `name` string, nullable, required: Name of tax - `payments` SalePayment[], required: Payment type and amount - `type` 'cash' | 'check' | 'debit' | 'credit' | 'multiple' | 'ach' | 'wire' | 'other' | 'unknown', required - `amount_paid` number, double, required: Amount in cents for this payment type - `customer` SaleCustomer, required - `customer_id` string, uuid, required - `pos_customer_id` string, nullable, required: The customer ID in the POS system - `type` 'medical' | 'rec', required - `dob` string, nullable, required: Customer Date of Birth yyyy-MM-dd - `id_type` 'drivers' | 'medical' | 'ssn' | 'passport' | 'medical_with_rec' | 'medical_with_state_card' | 'caregiver' | 'minor_medical' | 'temporary_minor_medical' | 'temporary_adult', required - `id_expiration_date` string, nullable, required: Customer ID Expiration Date - `fees` SaleFee[], required: Sale Fees - `fee_name` string, nullable, required: Name of the fee - `percent_amount` number, double, nullable, required: Fee percentage as a real number - `flat_amount` number, double, nullable, required: Flat amount of fee in cents - `included_in_subtotal` boolean, nullable, required: True if this fee's calculation is included in the subtotal - `compliance_status` 'unchecked' | 'red_flag' | 'green_checked' | 'warning', required - `compliance_exceptions` string[], nullable, required: Compliance Exceptions - `compliance_warnings` string[], nullable, required: Compliance Warnings - WholesaleSale - `id` string, uuid, required - `pos_sale_id` string, nullable, required: Sale ID in the POS system - `crb_id` string, uuid, required - `subtotal` number, double, nullable, required: Pre-tax dollar amount in cents - `total_discounts` number, double, nullable, required: Total discount amount in cents - `tax_paid` number, double, nullable, required: Tax amount in cents - `total_paid` number, double, nullable, required: Price + Tax in cents - `date` string, date-time, required - `local_date` string, required - `gc_created_date` string, date-time, required - `gc_updated_date` string, date-time, required - `transaction_type` 'sale' | 'return' | 'adjustment', required - `pos_name` 'Alleaves' | 'Apex Trading Wholesale' | 'Dutchie' | 'Dutchie Wholesale' | 'Cova' | 'Meadow' | 'MJ Freeway' | 'MJ Freeway Wholesale' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'Portal42' | 'Metrc S2S' | 'Metrc S2S Wholesale' | 'Flourish' | 'Flourish Wholesale' | 'Flowhub' | 'BioTrack' | 'BioTrack Wholesale' | 'Treez' | 'Blaze' | 'Quickbooks' | 'Sage Intacct' | 'Canix' | 'Brytemap' | 'POSaBIT' | 'Proteus420' | 'IndicaOnline' | 'Sweed' | 'Weave' | 'Jane' | 'Manual Upload Wholesale' | 'Cova Test Account' | 'Leaf Logix Test Account' | 'BioTrack Test Account' | 'Mj Freeway Test Account' | 'Treez IO Test Account' | 'Green Bits Test Account' | 'Manual Upload Retail' | 'SFTP Sales Retail' | 'SFTP Sales Wholesale' | 'Not Configured' | 'Unsupported' | 'CRBMonitor' | 'Plaid', required - `type` 'wholesale', required - `employee_id` string, nullable: Employee ID - `line_items` SaleLineItem[], required: Sale Line Items - `product_id` string, uuid, required - `pos_product_id` string, nullable, required: The product ID in the POS system - `product_name` string, nullable, required: Name in POS system - `num_units` number, double, nullable, required: Number of units bought - `price_per_unit` number, double, nullable, required: Price per individual unit - `grams` number, double, nullable, required: Weight of product in grams - `product_type` 'flower' | 'oil/concentrate' | 'edible' | 'other' | 'seedling' | 'seed' | 'liquid' | 'solid' | 'extract' | 'plant' | 'accessory' | 'marijuana_product' | 'topical' | 'edible_liquid', nullable, required - `cannabis_product` boolean, nullable, required: Whether product contains cannabis - `line_item_discounts` SaleDiscount[], required: Line item specific discounts - `flat_amount` number, double, nullable, required: Discount amount in cents - `pct_amount` number, double, nullable, required: Discount percentage as a real number - `name` string, nullable, required: Name of discount - `line_item_taxes` SaleTax[], required: Line item specific taxes - `flat_amount` number, double, nullable, required: Tax amount in cents - `pct_amount` number, double, nullable, required: Tax percentage as a real number - `name` string, nullable, required: Name of tax - `line_item_fees` SaleFee[], required: Line item specific fees - `fee_name` string, nullable, required: Name of the fee - `percent_amount` number, double, nullable, required: Fee percentage as a real number - `flat_amount` number, double, nullable, required: Flat amount of fee in cents - `included_in_subtotal` boolean, nullable, required: True if this fee's calculation is included in the subtotal - `discounts` SaleDiscount[], required: Sale Discounts - `flat_amount` number, double, nullable, required: Discount amount in cents - `pct_amount` number, double, nullable, required: Discount percentage as a real number - `name` string, nullable, required: Name of discount - `taxes` SaleTax[], required: Sale Taxes - `flat_amount` number, double, nullable, required: Tax amount in cents - `pct_amount` number, double, nullable, required: Tax percentage as a real number - `name` string, nullable, required: Name of tax - `payments` SalePayment[], required: Payment type and amount - `type` 'cash' | 'check' | 'debit' | 'credit' | 'multiple' | 'ach' | 'wire' | 'other' | 'unknown', required - `amount_paid` number, double, required: Amount in cents for this payment type - `customer` SaleCustomer, required - `customer_id` string, uuid, required - `pos_customer_id` string, nullable, required: The customer ID in the POS system - `type` 'medical' | 'rec', required - `dob` string, nullable, required: Customer Date of Birth yyyy-MM-dd - `id_type` 'drivers' | 'medical' | 'ssn' | 'passport' | 'medical_with_rec' | 'medical_with_state_card' | 'caregiver' | 'minor_medical' | 'temporary_minor_medical' | 'temporary_adult', required - `id_expiration_date` string, nullable, required: Customer ID Expiration Date - `fees` SaleFee[], required: Sale Fees - `fee_name` string, nullable, required: Name of the fee - `percent_amount` number, double, nullable, required: Fee percentage as a real number - `flat_amount` number, double, nullable, required: Flat amount of fee in cents - `included_in_subtotal` boolean, nullable, required: True if this fee's calculation is included in the subtotal - `invoice` object, required - `pos_customer_id` string, nullable, required: Wholesale POS customer ID - `memo` string, nullable, required: Invoice Memo - `open_balance` number, double, nullable, required: Invoice Open Balance - `total` number, double, nullable, required: Invoice Total - `id` string, nullable, required: Invoice Id ## Other responses - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `422`: Validation Failed --- [API](https://skmtc.dev/greencheckverified/apis/green-check-access.md) - [All operations](https://skmtc.dev/greencheckverified/apis/green-check-access/llms.txt) - [OpenAPI document](https://skmtc.dev/greencheckverified/apis/green-check-access/revisions/fb63a7a6151b?raw)