--- title: "POST receipt" method: POST path: "/v3/administrations/{administration_id}/registers/{register_id}/receipts" tags: ["Register Receipts"] --- # POST receipt `POST /v3/administrations/{administration_id}/registers/{register_id}/receipts` ## Request - Base URL: `https://api.bookingexperts.com` - URL: `https://api.bookingexperts.com/v3/administrations/{administration_id}/registers/{register_id}/receipts` - Auth: one of: - API key in header `X-API-KEY` - OAuth 2 - Authorization code: `/oauth/authorize` - Token URL: `/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Create a new receipt for a register. You can only create receipts for registers that have been added via POST register (App Managed). ## Path parameters - `administration_id` string, required - `register_id` string, required ## Query parameters - `fields[receipt]` string - `include` string ## Headers - `Accept-Language` string ## Request body - object - `data` object: A receipt is a document acknowledging that an Administration has received a Payment following a sale or other transfer of products. - `type` string: Type - `attributes` object: Attributes - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_vat` object - `currency` string - `value` string - `relationships` object: Relationships - `register` object - `data` object - `id` string: register ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `credited_receipt` object: The receipt that was credited, if any - `data` object - `id` string: credited_receipt ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `receipt_items` object - `data` object[] - `id` string: receipt_items ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `payments` object - `data` object[] - `id` string: payments ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `signatures` object - `data` object[] - `id` string: signatures ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` union[] - union - Register: A POS register of an administration. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string: Name of the register - `closed` boolean: Returns whether this register is currently closed - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Receipt: A receipt is a document acknowledging that an Administration has received a Payment following a sale or other transfer of products. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_vat` object - `currency` string - `value` string - `created_at` string, date-time - `type` 'ConceptReceipt' | 'PaymentReceipt' | 'RegisterCountReceipt' | 'SalesReceipt' - `api_managed` boolean: Whether this receipt was created through an App (true) or through the BEX POS directly (false) - `settled_with` string: Documents (mostly invoices) which are settled with this receipt. This typically occurs when an invoice is paid through the point of sale. - `links` object: Links - `url` string: Link to url - `relationships` object: Relationships - `register` object - `data` object - … - `credited_receipt` object: The receipt that was credited, if any - `data` object - … - `receipt_items` object - `data` object[] - … - `payments` object - `data` object[] - … - `signatures` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - ReceiptItem: Represents a line as part of a Receipt. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `quantity` integer - `vat_rate` number, double - `memo` string - `price` object - `currency` string - `value` string - `price_without_vat` object - `currency` string - `value` string - `price_vat` object - `currency` string - `value` string - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_vat` object - `currency` string - `value` string - `relationships` object: Relationships - `ledger_account` object - `data` object - … - `vat_tariff` object - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Payment: Represents a payment. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `paid_at` string, date: Local payment date - `amount` object: Paid amount - `currency` string - `value` string - `payment_type` 'cash' | 'pos' | 'psp' | 'batch' | 'transfer' | 'transfered_from_invoice' | 'transfered_to_invoice' | 'credited' | 'credit' | 'voucher' | 'transfered_to_voucher' | 'imported': Payment type. On create, this must be one of: cash, pin, psp, batch, transfer - `memo` string: An optional note - `terminal_identifier` string: An optional terminal identifier for POS payments - `description` string: A short description of this payment - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `payment_method` object - `data` object - … - `booking` object - `data` object - … - `invoice` object - `data` object - … - `register` object: Register is required when linked with a payment_method (through payment_type) that has pos_enabled, like cash or pin payments. - `data` object - … - `administration` object - `data` object - … - `receipt` object - `data` object - … - `settled_with` object: Yields the payment on the settled invoice or receipt (if any) - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Signature: A signature of a Receipt, obtained by having a Receipt signed by an external financial party, for example to meet Registrierkassensicherheitsverordnung (RKSV) regulations in Austria. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `signature_type` 'qr_code' - `signature` string - `caption` string - `created_at` string, date-time - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. ## Response `200` ReceiptCollectionResponse - object - `data` Receipt[] - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_vat` object - `currency` string - `value` string - `created_at` string, date-time - `type` 'ConceptReceipt' | 'PaymentReceipt' | 'RegisterCountReceipt' | 'SalesReceipt' - `api_managed` boolean: Whether this receipt was created through an App (true) or through the BEX POS directly (false) - `settled_with` string: Documents (mostly invoices) which are settled with this receipt. This typically occurs when an invoice is paid through the point of sale. - `links` object: Links - `url` string: Link to url - `relationships` object: Relationships - `register` object - `data` object - `id` string: register ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `credited_receipt` object: The receipt that was credited, if any - `data` object - `id` string: credited_receipt ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `receipt_items` object - `data` object[] - `id` string: receipt_items ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `payments` object - `data` object[] - `id` string: payments ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `signatures` object - `data` object[] - `id` string: signatures ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` union[] - union - Register: A POS register of an administration. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string: Name of the register - `closed` boolean: Returns whether this register is currently closed - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Receipt: A receipt is a document acknowledging that an Administration has received a Payment following a sale or other transfer of products. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_vat` object - `currency` string - `value` string - `created_at` string, date-time - `type` 'ConceptReceipt' | 'PaymentReceipt' | 'RegisterCountReceipt' | 'SalesReceipt' - `api_managed` boolean: Whether this receipt was created through an App (true) or through the BEX POS directly (false) - `settled_with` string: Documents (mostly invoices) which are settled with this receipt. This typically occurs when an invoice is paid through the point of sale. - `links` object: Links - `url` string: Link to url - `relationships` object: Relationships - `register` object - `data` object - … - `credited_receipt` object: The receipt that was credited, if any - `data` object - … - `receipt_items` object - `data` object[] - … - `payments` object - `data` object[] - … - `signatures` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - ReceiptItem: Represents a line as part of a Receipt. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `quantity` integer - `vat_rate` number, double - `memo` string - `price` object - `currency` string - `value` string - `price_without_vat` object - `currency` string - `value` string - `price_vat` object - `currency` string - `value` string - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_vat` object - `currency` string - `value` string - `relationships` object: Relationships - `ledger_account` object - `data` object - … - `vat_tariff` object - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Payment: Represents a payment. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `paid_at` string, date: Local payment date - `amount` object: Paid amount - `currency` string - `value` string - `payment_type` 'cash' | 'pos' | 'psp' | 'batch' | 'transfer' | 'transfered_from_invoice' | 'transfered_to_invoice' | 'credited' | 'credit' | 'voucher' | 'transfered_to_voucher' | 'imported': Payment type. On create, this must be one of: cash, pin, psp, batch, transfer - `memo` string: An optional note - `terminal_identifier` string: An optional terminal identifier for POS payments - `description` string: A short description of this payment - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `payment_method` object - `data` object - … - `booking` object - `data` object - … - `invoice` object - `data` object - … - `register` object: Register is required when linked with a payment_method (through payment_type) that has pos_enabled, like cash or pin payments. - `data` object - … - `administration` object - `data` object - … - `receipt` object - `data` object - … - `settled_with` object: Yields the payment on the settled invoice or receipt (if any) - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Signature: A signature of a Receipt, obtained by having a Receipt signed by an external financial party, for example to meet Registrierkassensicherheitsverordnung (RKSV) regulations in Austria. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `signature_type` 'qr_code' - `signature` string - `caption` string - `created_at` string, date-time - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `meta` object - `pagination` object - `total_records` integer - `page` integer - `size` integer ## Other responses - `429`: Error - `default`: Error --- [API](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3.md) - [All operations](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/revisions/ff81bc4fefa9?raw)