techrar docs
Home
Solutions
Solutions
  • eCommerce SaaS
  • Meals SaaS
  • Meals Marketplaces
API
API
  • Merchant APIs
  • Customer App APIs
  • Meals APIs
Techrar Connect
Home
Solutions
Solutions
  • eCommerce SaaS
  • Meals SaaS
  • Meals Marketplaces
API
API
  • Merchant APIs
  • Customer App APIs
  • Meals APIs
Techrar Connect
  1. Invoices
  • Getting Started
  • Merchant Account
    • Merchant Wallet
      • Wallet Details
      • Charge Wallet
    • Merchant Settings
    • List Bank Accounts
    • Update Merchant Settings
    • Organization Config
  • Customers
    • Locations
      • List Customer Locations
      • Customer Location Details
      • Create Customer Location
    • Memberships
      • List Customer Memberships
    • Customer Order Statistics
    • List Customers
    • Customer Details
    • Create Customer
    • Update Customer
  • Wallets
    • Customer Wallet Details
    • Deposit Points
    • Deposit Cashback
    • Redeem from Wallet
  • Vouchers
    • Get Voucher Discount
    • Update Voucher Usage
  • Items
    • Item Config Details
    • Update Item Config
    • List Items
    • Item Details
    • Create Item
    • Update Item
    • Delete Item
    • Reserve an item
    • Record Item Purchase
    • Bulk Update Items
    • Bulk Update Item Prices
  • Item Categories
    • List Item Categories
    • Item Category Details
    • Create Category
    • Update Category
    • Delete Category
  • Item Tags
    • List Item Tags
    • Create Tag
    • Update Tag
    • Delete Tag
  • Item Images
    • Create Item Image
    • Upadte Item Image
    • Delete Item Image
  • Item Discounts
    • Create Item Discount
    • Upadte Item Discount
    • Delete Item Discount
  • Item Bundles
    • List Bundle Categories
    • Bundle Category Details
    • Create Bundle Category
    • Update Bundle Category
    • Delete Bundle Category
  • Item Modifiers
    • List Modifier Categories
    • Modifier Category Details
    • Create Modifier Category
    • Update Modifier Category
    • Delete Modifier Category
  • Carts
    • List Carts
    • Cart Details
  • Orders
    • Checkout Config Details
    • Update Checkout Config
    • List Orders
    • Order Details
    • List Recurring Purchases
    • Recurring Purchase Details
    • Recurring Purchase Details
  • Invoices
    • Invoice Config Details
      GET
    • Update Invoice Config
      POST
    • List Invoices
      GET
    • Invoice Details
      GET
    • Refund Invoice
      POST
  • Transactions
    • List Transactions
    • Transaction Details
    • Capture Bank Transfer Transaction
    • Decline Bank Transfer Transaction
  • Subscriptions
    • List Subscriptions
    • Subscription Details
    • Subscriptions Statistics
    • Cancel Subscription Auto Renewal
    • Cancel Subscription
    • Increment Subscription Usage
    • Decrement Subscription Usage
    • Bulk Pause Subscriptions
    • Bulk Resume Subscriptions
    • Create Subscription Update
    • Cancel Subscription Update
  • Fulfillments
    • Fulfillment Overview
    • List Fulfillments
    • Fulfillment Details
    • Update Fulfillment Details
  • Tickets
    • List Tickets
    • Bulk Update Tickets
    • Validate Token and Check in Ticket
  • Shipments
    • Shipping Config Details
    • Update Shipping Config
    • Shipping Labels Details
    • Purchase Shipment Labels
    • Create Shipment
    • Cancel Shipment
    • Create Return Shipment
  • Pickup Locations
    • List Pickup Locations
    • Pickup Location Details
    • Create Pickup Location
    • Update Pickup Location Details
    • Delete Pickup Location
  • Couriers
    • List Couriers
    • Get Active Couriers
    • Get Couriers Prices
    • Courier Details
    • Create Custom Courier
    • Update Custom Courier Details
    • Delete Custom Courier
  • Geo & Places
    • List Countires
    • List Regions
    • List Cities
    • List Districts
  • Webhooks
    • List Webhooks
    • Create Webhook
    • Update Webhook Details
    • Delete Webhook
    • List Webhook Logs
    • Test Webhook
    • Delete Webhook By URL
  • Sales Channels
    • Meals
      • List Provider Meal Plans
      • Update Meals Plans Listings
      • List Provider Meals Orders
      • Provider Meals Order Details
      • List Provider Meals Subscriptions
      • Provider Meals Subscription Details
    • Sales Channel Profile Details
    • List Sales Channel Connections
    • Accept Sales Channel Connection Request
    • Reject Sales Channel Connection Request
    • Activate Sales Channel Connection
    • Deactivate Sales Channel Connection
    • Delete Sales Channel Connection Request
  • Notifications
    • Send Notification
  • Meals Plans
    • List Plan Tags
    • List Plans
    • Plan Details
    • Menu Details
  • Meals Logistics
    • City Details
    • Captain Details
    • Branch Details
    • List Supported Windows
    • List Captains
    • Bulk Update SubOrders
  1. Invoices

List Invoices

GET
https://api.techrar.com/order/v1/merchant/invoices/
This endpoint allows you to list all merchant invoices
Permission
can_read_order - orders read only
Filters
You can filter invoices with almost all the fields in the invoice e.g. payment_provider, status, ..etc
Light Objects
In most list endpoints, the returned object will be light.
Use the details endpoint to get a detailed object

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Header Params

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.techrar.com/order/v1/merchant/invoices/?search=&search=&page=1&page_size=5&order_by=' \
--header 'app-id: 4' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "count": 384,
    "next": "http://localhost/order/v1/merchant/invoices/?order_by=&page=2&page_size=5&search=",
    "previous": null,
    "results": [
        {
            "id": 608,
            "custom_fields": null,
            "order_id": 410,
            "customer": {
                "id": 35265,
                "country_code": "966",
                "username": "0535501059",
                "mobile_number": "966535501059",
                "email": "[email protected]",
                "name": "Ozel",
                "lang": "ar",
                "current_city_id": null,
                "is_email_verified": false,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "joined_at": "2025-06-02 12:10:54.881137+00:00",
                "national_id": null,
                "secondary_mobile_number": null,
                "date_of_birth": null,
                "avatar": null,
                "custom_fields": null
            },
            "invoice_pdf_en": null,
            "invoice_pdf_ar": null,
            "serial": "INV-202500375",
            "refunded_invoice": {
                "id": 603,
                "serial": "INV-202500374",
                "issued_at": "2025-08-20T08:08:02.156583Z",
                "total_amount": 327.32,
                "currency": "SAR",
                "status": "paid",
                "invoice_pdf_en": null,
                "invoice_pdf_ar": null,
                "custom_fields": null
            },
            "app_id": 86,
            "created_at": "2025-08-20T12:49:31.588396+03:00",
            "invoice_reference_id": null,
            "invoice_reference_serial": null,
            "type": "refund",
            "status": "paid",
            "refund_reason": "first refund",
            "issued_at": "2025-08-20T12:49:31+03:00",
            "due_at": "2025-08-20T12:49:31+03:00",
            "sub_total_amount": 10.33,
            "shipping_amount": 0.0,
            "setup_amount": 0.0,
            "net_amount": 10.33,
            "sub_total_discounts_amount": 0.0,
            "shipping_discounts_amount": 0.0,
            "total_discounts_amount": 0.0,
            "total_amount_excluding_tax": 8.98,
            "tax_percentage": 15.0,
            "tax_amount": 1.35,
            "total_amount": 10.33,
            "wallet_redeem_amount": 0.0,
            "total_amount_with_redeem": 0.0,
            "currency": "SAR",
            "payment_method": "visa_master",
            "payment_provider": "myfatoorah",
            "is_auto_renewal": false,
            "invoice_provider": "fai",
            "zatca_status": "aborted",
            "invoice_error": "Parent invoice must be successfully published before creating a return invoice."
        },
        {
            "id": 603,
            "custom_fields": null,
            "order_id": 410,
            "customer": {
                "id": 35265,
                "country_code": "966",
                "username": "0535501059",
                "mobile_number": "966535501059",
                "email": "[email protected]",
                "name": "Ozel",
                "lang": "ar",
                "current_city_id": null,
                "is_email_verified": false,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "joined_at": "2025-06-02 12:10:54.881137+00:00",
                "national_id": null,
                "secondary_mobile_number": null,
                "date_of_birth": null,
                "avatar": null,
                "custom_fields": null
            },
            "invoice_pdf_en": null,
            "invoice_pdf_ar": null,
            "serial": "INV-202500374",
            "refunded_invoice": null,
            "app_id": 86,
            "created_at": "2025-08-20T11:08:02.157398+03:00",
            "invoice_reference_id": null,
            "invoice_reference_serial": null,
            "type": "normal",
            "status": "paid",
            "refund_reason": null,
            "issued_at": "2025-08-20T11:08:02.156583+03:00",
            "due_at": "2025-08-20T11:08:02.156586+03:00",
            "sub_total_amount": 327.32,
            "shipping_amount": 0.0,
            "setup_amount": 0.0,
            "net_amount": 327.32,
            "sub_total_discounts_amount": 0.0,
            "shipping_discounts_amount": 0.0,
            "total_discounts_amount": 0.0,
            "total_amount_excluding_tax": 284.63,
            "tax_percentage": 15.0,
            "tax_amount": 42.69,
            "total_amount": 327.32,
            "wallet_redeem_amount": 0.0,
            "total_amount_with_redeem": 327.32,
            "currency": "SAR",
            "payment_method": "visa_master",
            "payment_provider": "myfatoorah",
            "is_auto_renewal": false,
            "invoice_provider": "fai",
            "zatca_status": "failed",
            "invoice_error": "Failed to create e-invoice after 4 attempts: {'code': -301, 'detail': \"({'fai'}) is invalid value\", 'alert': False}"
        },
        {
            "id": 602,
            "custom_fields": null,
            "order_id": 226,
            "customer": {
                "id": 1,
                "country_code": "966",
                "username": "0534501056",
                "mobile_number": "966534501056",
                "email": "[email protected]",
                "name": "Safwan Saigh",
                "lang": "en",
                "current_city_id": 1,
                "is_email_verified": true,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "national_id": "1111782031",
                "secondary_mobile_number": "0534501056",
                "date_of_birth": "1999-02-25",
                "avatar": "/media/uploads/customer/avatars/2024/07/29/12048986-a1b6-4e1d-9b8a-216331f3cd71.png",
                "joined_at": "2022-03-12T14:51:15.115924Z",
                "custom_fields": null
            },
            "invoice_pdf_en": null,
            "invoice_pdf_ar": null,
            "serial": "INV-202500373",
            "refunded_invoice": null,
            "app_id": 86,
            "created_at": "2025-08-20T09:17:55.292035+03:00",
            "invoice_reference_id": null,
            "invoice_reference_serial": null,
            "type": "normal",
            "status": "paid",
            "refund_reason": null,
            "issued_at": "2025-08-20T09:17:55.291636+03:00",
            "due_at": "2025-08-20T09:17:55.291643+03:00",
            "sub_total_amount": 0.0,
            "shipping_amount": 0.0,
            "setup_amount": 0.0,
            "net_amount": 0.0,
            "sub_total_discounts_amount": 0.0,
            "shipping_discounts_amount": 0.0,
            "total_discounts_amount": 0.0,
            "total_amount_excluding_tax": 0.0,
            "tax_percentage": 15.0,
            "tax_amount": 0.0,
            "total_amount": 0.0,
            "wallet_redeem_amount": 0.0,
            "total_amount_with_redeem": 0.0,
            "currency": "SAR",
            "payment_method": "free",
            "payment_provider": "techrar",
            "is_auto_renewal": true,
            "invoice_provider": "fai",
            "zatca_status": "failed",
            "invoice_error": "Failed to create e-invoice after 4 attempts: {'code': -301, 'detail': \"({'fai'}) is invalid value\", 'alert': False}"
        },
        {
            "id": 601,
            "custom_fields": null,
            "order_id": 246,
            "customer": {
                "id": 35264,
                "country_code": "966",
                "username": "0534591023",
                "mobile_number": "966534591023",
                "email": "[email protected]",
                "name": "Youcef",
                "lang": "ar",
                "current_city_id": null,
                "is_email_verified": false,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "national_id": null,
                "secondary_mobile_number": null,
                "date_of_birth": null,
                "avatar": null,
                "joined_at": "2025-05-07T14:41:22.993364Z",
                "custom_fields": null
            },
            "invoice_pdf_en": null,
            "invoice_pdf_ar": null,
            "serial": "INV-202500372",
            "refunded_invoice": null,
            "app_id": 86,
            "created_at": "2025-08-19T19:21:44.584219+03:00",
            "invoice_reference_id": null,
            "invoice_reference_serial": null,
            "type": "normal",
            "status": "paid",
            "refund_reason": null,
            "issued_at": "2025-08-19T19:21:44.577920+03:00",
            "due_at": "2025-08-19T19:21:44.577926+03:00",
            "sub_total_amount": 0.0,
            "shipping_amount": 0.0,
            "setup_amount": 0.0,
            "net_amount": 0.0,
            "sub_total_discounts_amount": 0.0,
            "shipping_discounts_amount": 0.0,
            "total_discounts_amount": 0.0,
            "total_amount_excluding_tax": 0.0,
            "tax_percentage": 15.0,
            "tax_amount": 0.0,
            "total_amount": 0.0,
            "wallet_redeem_amount": 0.0,
            "total_amount_with_redeem": 0.0,
            "currency": "SAR",
            "payment_method": "free",
            "payment_provider": "techrar",
            "is_auto_renewal": true,
            "invoice_provider": "fai",
            "zatca_status": "failed",
            "invoice_error": "Failed to create e-invoice after 4 attempts: {'code': -301, 'detail': \"({'fai'}) is invalid value\", 'alert': False}"
        },
        {
            "id": 600,
            "custom_fields": null,
            "order_id": 409,
            "customer": {
                "id": 35264,
                "country_code": "966",
                "username": "0534591023",
                "mobile_number": "966534591023",
                "email": "[email protected]",
                "name": "Youcef",
                "lang": "ar",
                "current_city_id": null,
                "is_email_verified": false,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "joined_at": "2025-05-07 14:41:23.033693+00:00",
                "national_id": null,
                "secondary_mobile_number": null,
                "date_of_birth": null,
                "avatar": null,
                "custom_fields": null
            },
            "invoice_pdf_en": null,
            "invoice_pdf_ar": null,
            "serial": "INV-202500371",
            "refunded_invoice": {
                "id": 595,
                "serial": "INV-202500366",
                "issued_at": "2025-08-18T09:12:05Z",
                "total_amount": 57.0,
                "currency": "SAR",
                "status": "paid",
                "invoice_pdf_en": null,
                "invoice_pdf_ar": null,
                "custom_fields": null
            },
            "app_id": 86,
            "created_at": "2025-08-19T17:52:12.294973+03:00",
            "invoice_reference_id": null,
            "invoice_reference_serial": null,
            "type": "refund",
            "status": "paid",
            "refund_reason": "test test",
            "issued_at": "2025-08-19T17:52:12.260231+03:00",
            "due_at": "2025-08-19T17:52:12.260242+03:00",
            "sub_total_amount": 57.0,
            "shipping_amount": 0.0,
            "setup_amount": 0.0,
            "net_amount": 57.0,
            "sub_total_discounts_amount": 0.0,
            "shipping_discounts_amount": 0.0,
            "total_discounts_amount": 0.0,
            "total_amount_excluding_tax": 49.57,
            "tax_percentage": 15.0,
            "tax_amount": 7.43,
            "total_amount": 57.0,
            "wallet_redeem_amount": 0.0,
            "total_amount_with_redeem": 0.0,
            "currency": "SAR",
            "payment_method": "visa_master",
            "payment_provider": "myfatoorah",
            "is_auto_renewal": false,
            "invoice_provider": "fai",
            "zatca_status": "aborted",
            "invoice_error": "Parent invoice must be successfully published before creating a return invoice."
        }
    ]
}
Modified at 2025-08-20 10:09:55
Previous
Update Invoice Config
Next
Invoice Details
Built with