Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getbeed.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Base URL

The base URL for all API requests is: https://services.getbeed.com/api

​
Endpoints

POST /external/extraction/new

​
Headers

  • x-api-key (required): API Key (structure: <key>:<secret>)

​
Parameters

  • type (required): Type of document (INVOICE, RECEIPT)

​
Form data

  • file (required): Binary file (image/pdf)

​
Example

​
Request

POST /v1/external/extraction/new?type=RECEIPT
Reference file Sample receipt Success response 
{
  "statusCode": 201,
  "message": "extraction.demo",
  "_metadata": {
    "languages": ["en"],
    "timestamp": 1731244568105,
    "timezone": "Asia/Jakarta",
    "requestId": "08666cdc-0385-4e91-a426-7f4869ab3f54",
    "path": "/api/v1/public/extraction/demo",
    "version": "1",
    "repoVersion": "5.7.0"
  },
  "data": {
    "merchant_name": "Walmart",
    "merchant_address": "231 BLUEBELL DR SW\nNEW PHILADELPHIA OH 44663",
    "transaction_date": "07/28/17",
    "transaction_time": "02:39:48",
    "sub_total": "93.62",
    "total": "98.21",
    "line_items": [
      {
        "total_price": "1.97",
        "description": "PET TOY",
        "quantity": "",
        "price": "",
        "product_code": "004747571658",
        "quantity_unit": ""
      },
      {
        "total_price": "1.97",
        "description": "FLOPPY PUPPY",
        "quantity": "",
        "price": "",
        "product_code": "004747514846",
        "quantity_unit": ""
      },
      {
        "total_price": "4.97",
        "description": "SSSUPREME S",
        "quantity": "",
        "price": "",
        "product_code": "070060332153",
        "quantity_unit": ""
      },
      {
        "total_price": "5.92",
        "description": "2.5 SQUEAK",
        "quantity": "",
        "price": "",
        "product_code": "084699803238",
        "quantity_unit": ""
      },
      {
        "total_price": "3.77",
        "description": "MUNCHY DMBEL",
        "quantity": "",
        "price": "",
        "product_code": "068113108796",
        "quantity_unit": ""
      },
      {
        "total_price": "2.92",
        "description": "DOG TREAT",
        "quantity": "",
        "price": "",
        "product_code": "007119013654",
        "quantity_unit": ""
      },
      {
        "total_price": "0.50",
        "description": "PED PCH 1",
        "quantity": "",
        "price": "",
        "product_code": "002310011802",
        "quantity_unit": ""
      },
      {
        "total_price": "0.50",
        "description": "PED PCH 1",
        "quantity": "",
        "price": "",
        "product_code": "002310011802",
        "quantity_unit": ""
      },
      {
        "total_price": "1.00-",
        "description": "COUPON 23100",
        "quantity": "",
        "price": "",
        "product_code": "052310037000",
        "quantity_unit": ""
      },
      {
        "total_price": "3.98",
        "description": "HNYMD SMORES",
        "quantity": "",
        "price": "",
        "product_code": "088491226837",
        "quantity_unit": ""
      },
      {
        "total_price": "1.98",
        "description": "FRENCH DRSNG",
        "quantity": "",
        "price": "",
        "product_code": "004132100655",
        "quantity_unit": ""
      },
      {
        "total_price": "5.47",
        "description": "3\nORANGES",
        "quantity": "",
        "price": "",
        "product_code": "001466835001",
        "quantity_unit": ""
      },
      {
        "total_price": "1.48",
        "description": "BABY CARROTS",
        "quantity": "",
        "price": "",
        "product_code": "003338366602",
        "quantity_unit": ""
      },
      {
        "total_price": "1.24",
        "description": "COLLARDS",
        "quantity": "",
        "price": "",
        "product_code": "000000004614KI",
        "quantity_unit": ""
      },
      {
        "total_price": "2.50",
        "description": "CALZONE",
        "quantity": "",
        "price": "",
        "product_code": "005208362080",
        "quantity_unit": ""
      },
      {
        "total_price": "19.77",
        "description": "MM RVW MNT",
        "quantity": "",
        "price": "",
        "product_code": "003399105848",
        "quantity_unit": ""
      },
      {
        "total_price": "1.97",
        "description": "STKOBRLPLABL",
        "quantity": "",
        "price": "",
        "product_code": "001558679414",
        "quantity_unit": ""
      },
      {
        "total_price": "1.97",
        "description": "STKOBRLPLABL",
        "quantity": "",
        "price": "",
        "product_code": "001558679414",
        "quantity_unit": ""
      },
      {
        "total_price": "0.97",
        "description": "STKO SUNFLWR",
        "quantity": "",
        "price": "",
        "product_code": "001558679410",
        "quantity_unit": ""
      },
      {
        "total_price": "0.97",
        "description": "STKO SUNFLWR",
        "quantity": "",
        "price": "",
        "product_code": "001558679410",
        "quantity_unit": ""
      },
      {
        "total_price": "0.97",
        "description": "STKO SUNFLWR",
        "quantity": "",
        "price": "",
        "product_code": "001558679410",
        "quantity_unit": ""
      },
      {
        "total_price": "0.97",
        "description": "STKO SUNFLWR",
        "quantity": "",
        "price": "",
        "product_code": "001558679410",
        "quantity_unit": ""
      },
      {
        "total_price": "0.97",
        "description": "BLING BEADS",
        "quantity": "",
        "price": "",
        "product_code": "076594060699",
        "quantity_unit": ""
      },
      {
        "total_price": "9.97",
        "description": "GREAT VALUE",
        "quantity": "",
        "price": "",
        "product_code": "007874203191",
        "quantity_unit": ""
      },
      {
        "total_price": "4.48",
        "description": "LIPTON",
        "quantity": "",
        "price": "",
        "product_code": "001200011224",
        "quantity_unit": ""
      },
      {
        "total_price": "12.44",
        "description": "DRY DOG",
        "quantity": "",
        "price": "",
        "product_code": "002310011035",
        "quantity_unit": ""
      }
    ]
  }
}

​
Response fields

​
Receipt

  • merchant_name: Name of the merchant
  • merchant_address: Address of the merchant
  • transaction_date: Date of the transaction
  • transaction_time: Time of the transaction
  • sub_total: Subtotal of the transaction
  • total: Total amount of the transaction
  • line_items: List of items in the transaction
    • total_price: Total price of the item
    • description: Description of the item
    • quantity: Quantity of the item
    • price: Price of the item
    • product_code: Product code of the item
    • quantity_unit: Quantity unit of the item

​
Invoice

  • billing_address: Address of the billing
  • billing_address_recipient: Recipient of the billing address
  • customer_name: Name of the customer
  • invoice_date: Date of the invoice
  • invoice_id: ID of the invoice
  • invoice_total: Total amount of the invoice
  • payment_term: Payment term of the invoice
  • vendor_address: Address of the vendor
  • vendor_address_recipient: Recipient of the vendor address
  • vendor_name: Name of the vendor
  • due_date: Due date of the invoice
  • sub_total: Subtotal of the invoice
  • previous_unpaid_balance: Previous unpaid balance
  • total_tax: Total tax of the invoice
  • amount_due: Amount due of the invoice
  • po_number: PO number of the invoice
  • line_items: List of items in the invoice
    • amount: Amount of the item
    • date: Date of the item
    • description: Description of the item
    • quantity: Quantity of the item
    • product_code: Product code of the item
    • tax: Tax of the item
    • tax_rate: Tax rate of the item
    • unit: Unit of the item
    • unit_price: Unit price of the item

​
Errors

This API uses the following error codes:
  • 400 Bad Request: The request was malformed or missing required parameters.
  • 401 Unauthorized: The API key provided was invalid or missing.
  • 404 Not Found: The requested resource was not found.
  • 500 Internal Server Error: An unexpected error occurred on the server.

​
Credentials

In order to use the API, you need to have an API key and secret. You can get the API key by emailing us at founders@getbeed.com. Or use our free API key for testing: 
key: gZbXDVybwceoignNdKDE
secret: rwgVgqNhutmdAxBwDLvTkvRnmLGfLupwQFEdQXkv