ReDoc documentation

invoices/{id}

invoices/{id}

get/V1/invoices/{id}

Loads a specified invoice.

Request
path Parameters
id
required
integer

The invoice ID.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "base_currency_code": "string",
  • "base_discount_amount": 0,
  • "base_grand_total": 0,
  • "base_discount_tax_compensation_amount": 0,
  • "base_shipping_amount": 0,
  • "base_shipping_discount_tax_compensation_amnt": 0,
  • "base_shipping_incl_tax": 0,
  • "base_shipping_tax_amount": 0,
  • "base_subtotal": 0,
  • "base_subtotal_incl_tax": 0,
  • "base_tax_amount": 0,
  • "base_total_refunded": 0,
  • "base_to_global_rate": 0,
  • "base_to_order_rate": 0,
  • "billing_address_id": 0,
  • "can_void_flag": 0,
  • "created_at": "string",
  • "discount_amount": 0,
  • "discount_description": "string",
  • "email_sent": 0,
  • "entity_id": 0,
  • "global_currency_code": "string",
  • "grand_total": 0,
  • "discount_tax_compensation_amount": 0,
  • "increment_id": "string",
  • "is_used_for_refund": 0,
  • "order_currency_code": "string",
  • "order_id": 0,
  • "shipping_address_id": 0,
  • "shipping_amount": 0,
  • "shipping_discount_tax_compensation_amount": 0,
  • "shipping_incl_tax": 0,
  • "shipping_tax_amount": 0,
  • "state": 0,
  • "store_currency_code": "string",
  • "store_id": 0,
  • "store_to_base_rate": 0,
  • "store_to_order_rate": 0,
  • "subtotal": 0,
  • "subtotal_incl_tax": 0,
  • "tax_amount": 0,
  • "total_qty": 0,
  • "transaction_id": "string",
  • "updated_at": "string",
  • "items": [
    ],
  • "comments": [
    ],
  • "extension_attributes": {
    }
}
➔ Next to invoices/{id}/capture