# Invoices ## Retrieve invoice > Retrieve a specific invoice by ID. ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}},"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}}},"schemas":{"Invoice":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/Invoice"}}},"InvoiceType":{"type":"string","enum":["purchase","refund"]},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"InvoiceHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice"},"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the invoice"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the invoice was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the invoice was created"}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"403":{"description":"Forbidden"},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/invoice/{id}":{"get":{"summary":"Retrieve invoice","description":"Retrieve a specific invoice by ID.","tags":["Invoices"],"parameters":[{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/hyper"}],"responses":{"200":{"description":"Invoice retrieved successfully","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Invoice"},{"$ref":"#/components/schemas/InvoiceHyperlinked"}]}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Retrieve detailed invoice > Retrieve a specific invoice by ID with detailed information. ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}},"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}}},"schemas":{"InvoiceDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/Invoice"},"invoiceitem_set":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"}},"paymentinvoiceitem_set":{"type":"array","items":{"$ref":"#/components/schemas/PaymentInvoiceItem"}},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the invoice"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the invoice was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the invoice was created"}}},"InvoiceType":{"type":"string","enum":["purchase","refund"]},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"Invoice":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/Invoice"}}},"InvoiceItem":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the invoice item"},"invoice":{"type":"integer","description":"Related invoice ID"},"order_item":{"type":"integer","description":"Related order item ID"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the invoice item"},"tax_amount":{"type":"number","format":"decimal","description":"Tax amount of the invoice item"},"discount_rate":{"type":"number","format":"decimal","description":"Discount rate of the invoice item"},"discount_amount":{"type":"number","format":"decimal","description":"Discount amount of the invoice item"},"total_amount":{"type":"number","format":"decimal","description":"Total amount of the invoice item"},"net_amount":{"type":"number","format":"decimal","description":"Net amount of the invoice item"},"related_invoice_item":{"type":"integer","description":"Related invoice item ID"}}},"PaymentInvoiceItem":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the payment invoice item"},"invoice":{"type":"integer","description":"Related invoice ID"},"order_transaction":{"type":"integer","description":"Related order transaction ID"},"instant_amount":{"type":"number","format":"decimal","description":"Instant amount of the payment invoice item"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was created"}}},"InvoiceDetailedHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice"},"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the invoice"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the invoice was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the invoice was created"},"invoiceitem_set":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItemHyperlinked"}},"paymentinvoiceitem_set":{"type":"array","items":{"$ref":"#/components/schemas/PaymentInvoiceItemHyperlinked"}}}},"InvoiceHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice"},"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the invoice"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the invoice was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the invoice was created"}}},"InvoiceItemHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice item"},"pk":{"type":"integer","description":"Primary key of the invoice item"},"invoice":{"type":"string","format":"uuid","description":"Related invoice ID"},"order_item":{"type":"string","format":"uuid","description":"Related order item ID"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the invoice item"},"tax_amount":{"type":"number","format":"decimal","description":"Tax amount of the invoice item"},"discount_rate":{"type":"number","format":"decimal","description":"Discount rate of the invoice item"},"discount_amount":{"type":"number","format":"decimal","description":"Discount amount of the invoice item"},"total_amount":{"type":"number","format":"decimal","description":"Total amount of the invoice item"},"net_amount":{"type":"number","format":"decimal","description":"Net amount of the invoice item"},"related_invoice_item":{"type":"string","format":"uuid","description":"Related invoice item ID"}}},"PaymentInvoiceItemHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the payment invoice item"},"pk":{"type":"integer","description":"Primary key of the payment invoice item"},"invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"order_transaction":{"$ref":"#/components/schemas/OrderTransactionHyperlinked"},"instant_amount":{"type":"number","format":"decimal","description":"Instant amount of the payment invoice item"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was created"}}},"OrderTransactionHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the order transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the order transaction"},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"amount":{"type":"number","format":"decimal","description":"Amount of the order transaction"},"transaction_type":{"$ref":"#/components/schemas/OrderTransactionType"},"order":{"$ref":"#/components/schemas/Order"},"transaction_content_type":{"$ref":"#/components/schemas/ContentType"},"transaction_object_id":{"type":"integer","description":"ID of the related transaction object"},"transaction":{"$ref":"#/components/schemas/Transaction"},"customer":{"$ref":"#/components/schemas/Customer"},"related_ordertransaction":{"$ref":"#/components/schemas/OrderTransaction"},"related_cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"refund_payment_plan":{"$ref":"#/components/schemas/RefundPaymentPlan"},"mapping":{"$ref":"#/components/schemas/IntegrationMapping"},"integration":{"$ref":"#/components/schemas/IntegrationRelation"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was created"}}},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"OrderTransactionType":{"type":"string","enum":["purchase","refund"]},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"Transaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"type":"string","description":"Related point of sale ID"},"main_pos":{"type":"string","description":"Main point of sale ID"},"order":{"type":"integer","description":"ID of the related order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the order transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the order transaction"},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"amount":{"type":"number","format":"decimal","description":"Amount of the order transaction"},"transaction_type":{"$ref":"#/components/schemas/OrderTransactionType"},"order":{"$ref":"#/components/schemas/Order"},"transaction_content_type":{"$ref":"#/components/schemas/ContentType"},"transaction_object_id":{"type":"integer","description":"ID of the related transaction object"},"transaction":{"$ref":"#/components/schemas/Transaction"},"customer":{"$ref":"#/components/schemas/Customer"},"related_ordertransaction":{"$ref":"#/components/schemas/OrderTransaction"},"related_cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"refund_payment_plan":{"$ref":"#/components/schemas/RefundPaymentPlan"},"mapping":{"$ref":"#/components/schemas/IntegrationMapping"},"integration":{"$ref":"#/components/schemas/IntegrationRelation"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was created"}}},"CancellationPlan":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan"},"order":{"$ref":"#/components/schemas/Order"},"invoice_number":{"type":"string","description":"Invoice number associated with the cancellation plan"},"order_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Amount refunded for shipping"},"status":{"$ref":"#/components/schemas/CancellationPlanStatus"},"retail_store_remote_id":{"type":"string","description":"Remote ID of the retail store associated with the cancellation plan"},"refund_amount":{"type":"number","format":"float","description":"Refund amount"},"discount_refund_amount":{"type":"number","format":"float","description":"Discount refund amount"},"plan_type":{"$ref":"#/components/schemas/CancellationPlanType"},"cancellationplanorderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlanOrderItemDetailed"}},"staff_remote_id":{"type":"string","description":"Remote ID of the staff member"},"created_by":{"$ref":"#/components/schemas/User"},"last_updated_by":{"$ref":"#/components/schemas/User"},"payment_plan":{"type":"object","description":"A JSON object to store payment plan details"},"modified_by_id":{"type":"integer","description":"ID of the user who last modified the cancellation plan"}}},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}},"RefundPaymentPlan":{"allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the refund payment plan"},"cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"transaction_type":{"$ref":"#/components/schemas/PaymentType"},"refund_amount":{"type":"number","format":"decimal","description":"Refund amount of the refund payment plan"},"retry_count":{"type":"integer","description":"Retry count of the refund payment plan"},"status":{"$ref":"#/components/schemas/RefundPaymentPlanStatus"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was created"}}},"PaymentType":{"type":"object","enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","masterpass_rest","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Status of the payment type."},"RefundPaymentPlanStatus":{"type":"string","enum":["pending","completed","failed"],"description":"Status of the refund payment plan"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"403":{"description":"Forbidden"},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}}}},"paths":{"/api/v1/invoice/{id}/detailed/":{"get":{"summary":"Retrieve detailed invoice","description":"Retrieve a specific invoice by ID with detailed information.","tags":["Invoices"],"parameters":[{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/hyper"}],"responses":{"200":{"description":"Detailed invoice retrieved successfully","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvoiceDetailed"},{"$ref":"#/components/schemas/InvoiceDetailedHyperlinked"}]}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}}}} ``` ## List invoices > Retrieve a list of invoices with optional filtering. ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"uuid":{"name":"uuid","in":"query","description":"Filter by UUID.","required":false,"schema":{"type":"string"}},"invoice_type":{"name":"invoice_type","in":"query","description":"Filter by invoice type.","required":false,"schema":{"type":"string","enum":["purchase","refund"]}},"order":{"name":"order","in":"query","description":"Filter by order ID.","required":false,"schema":{"type":"number"}},"channel":{"name":"channel","in":"query","description":"ID of the channel the customer belongs to","required":false,"schema":{"type":"integer"}},"related_invoice":{"name":"related_invoice","in":"query","description":"Filter by related invoice.","required":false,"schema":{"type":"integer"}},"created_date":{"name":"created_date","in":"query","required":false,"description":"Filter by creation date using supported lookup expressions (e.g., `gt`, `gte`, `lt`, `lte`, `date__gt`, etc.).","schema":{"type":"string","format":"date-time"}},"modified_date":{"name":"modified_date","in":"query","required":false,"description":"Filter by modification date using supported lookup expressions (e.g., `gt`, `gte`, `lt`, `lte`, `date__gt`, etc.).","schema":{"type":"string","format":"date-time"}},"pk__in":{"name":"pk__in","in":"query","description":"Filter by multiple primary key values (comma-separated list of integers)","required":false,"schema":{"type":"array","items":{"type":"integer"}},"style":"form","explode":false},"pk__gt":{"name":"pk__gt","in":"query","description":"Filter by primary key greater than a specific value.","schema":{"type":"string"}},"pk__gte":{"name":"pk__gte","in":"query","required":false,"description":"Filters by primary key greater than or equal to the given value","schema":{"type":"integer"}},"pk__lt":{"name":"pk__lt","in":"query","required":false,"description":"Filters by primary key less than the given value","schema":{"type":"integer"}},"pk__lte":{"name":"pk__lte","in":"query","required":false,"description":"Filters by primary key less than or equal to the given value","schema":{"type":"integer"}}},"schemas":{"Invoice":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/Invoice"}}},"InvoiceType":{"type":"string","enum":["purchase","refund"]},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"InvoiceHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice"},"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the invoice"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the invoice was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the invoice was created"}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"403":{"description":"Forbidden"},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/invoice/":{"get":{"summary":"List invoices","description":"Retrieve a list of invoices with optional filtering.","tags":["Invoices"],"parameters":[{"$ref":"#/components/parameters/hyper"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/invoice_type"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/channel"},{"$ref":"#/components/parameters/related_invoice"},{"$ref":"#/components/parameters/created_date"},{"$ref":"#/components/parameters/modified_date"},{"$ref":"#/components/parameters/pk__in"},{"$ref":"#/components/parameters/pk__gt"},{"$ref":"#/components/parameters/pk__gte"},{"$ref":"#/components/parameters/pk__lt"},{"$ref":"#/components/parameters/pk__lte"}],"responses":{"200":{"description":"A list of invoices.","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of results."},"next":{"type":"string","format":"uri","nullable":true,"description":"URL of the next page of results."},"previous":{"type":"string","format":"uri","nullable":true,"description":"URL of the previous page of results."},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Invoice"},{"$ref":"#/components/schemas/InvoiceHyperlinked"}]}}}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## List invoices > Retrieve a list of invoices with optional filtering. ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"uuid":{"name":"uuid","in":"query","description":"Filter by UUID.","required":false,"schema":{"type":"string"}},"invoice_type":{"name":"invoice_type","in":"query","description":"Filter by invoice type.","required":false,"schema":{"type":"string","enum":["purchase","refund"]}},"order":{"name":"order","in":"query","description":"Filter by order ID.","required":false,"schema":{"type":"number"}},"channel":{"name":"channel","in":"query","description":"ID of the channel the customer belongs to","required":false,"schema":{"type":"integer"}},"related_invoice":{"name":"related_invoice","in":"query","description":"Filter by related invoice.","required":false,"schema":{"type":"integer"}},"created_date":{"name":"created_date","in":"query","required":false,"description":"Filter by creation date using supported lookup expressions (e.g., `gt`, `gte`, `lt`, `lte`, `date__gt`, etc.).","schema":{"type":"string","format":"date-time"}},"modified_date":{"name":"modified_date","in":"query","required":false,"description":"Filter by modification date using supported lookup expressions (e.g., `gt`, `gte`, `lt`, `lte`, `date__gt`, etc.).","schema":{"type":"string","format":"date-time"}},"pk__in":{"name":"pk__in","in":"query","description":"Filter by multiple primary key values (comma-separated list of integers)","required":false,"schema":{"type":"array","items":{"type":"integer"}},"style":"form","explode":false},"pk__gt":{"name":"pk__gt","in":"query","description":"Filter by primary key greater than a specific value.","schema":{"type":"string"}},"pk__gte":{"name":"pk__gte","in":"query","required":false,"description":"Filters by primary key greater than or equal to the given value","schema":{"type":"integer"}},"pk__lt":{"name":"pk__lt","in":"query","required":false,"description":"Filters by primary key less than the given value","schema":{"type":"integer"}},"pk__lte":{"name":"pk__lte","in":"query","required":false,"description":"Filters by primary key less than or equal to the given value","schema":{"type":"integer"}}},"schemas":{"Invoice":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/Invoice"}}},"InvoiceType":{"type":"string","enum":["purchase","refund"]},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"InvoiceHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice"},"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the invoice"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the invoice was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the invoice was created"}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"403":{"description":"Forbidden"},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/invoice/detailed/":{"get":{"summary":"List invoices","description":"Retrieve a list of invoices with optional filtering.","tags":["Invoices"],"parameters":[{"$ref":"#/components/parameters/hyper"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/invoice_type"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/channel"},{"$ref":"#/components/parameters/related_invoice"},{"$ref":"#/components/parameters/created_date"},{"$ref":"#/components/parameters/modified_date"},{"$ref":"#/components/parameters/pk__in"},{"$ref":"#/components/parameters/pk__gt"},{"$ref":"#/components/parameters/pk__gte"},{"$ref":"#/components/parameters/pk__lt"},{"$ref":"#/components/parameters/pk__lte"}],"responses":{"200":{"description":"A list of invoices.","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of results."},"next":{"type":"string","format":"uri","nullable":true,"description":"URL of the next page of results."},"previous":{"type":"string","format":"uri","nullable":true,"description":"URL of the previous page of results."},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Invoice"},{"$ref":"#/components/schemas/InvoiceHyperlinked"}]}}}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://apidocs.akinon.com/omnitron-openapis/invoices.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.