GET /sales/quotes

GET 
/sales/quotes

GET /sales/quotes

Request

Query Parameters

id int64[]
shopify_object_id int64[]
stripe_object_id string[]
woocommerce_order_id int64[]
eshop_order_id int64[]
payment_status string[]
customer.id int64
customer.business_name string
customer.display_name string
customer.reg_no string
customer.vat_no string
customer.tax_no string
customer.address.name string
customer.address.company string
customer.address.address1 string
customer.address.address2 string
customer.address.postal_code string
customer.address.city string
customer.address.region string
customer.address.country string

Possible values: <= 2 characters

customer.email string
customer.preferred_locale string
customer.phone string
description string
currency string
transaction_type.id int64
transaction_type.name string
transaction_type.associated_payment_cards string[]
from int32
take int32
search string
sort string[]

Responses

200

OK

text/plain

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuidnullable

created_at date-timenullable

edited_at date-timenullable

is_locked boolean

total_amount doublenullable

subtotal_amount doublenullable

amount_paid doublenullable

amount_due doublenullable

total_items_amount doublenullable

total_taxes_amount doublenullable

total_taxes_rate doublenullable

bank_account

object

id int32nullable

account_number stringnullable

billing_address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

counter_id int32nullable

currency stringnullable

Possible values: <= 3 characters

customer

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable

culture stringnullable

date_issued datenullable

date_taxable datenullable

date_due datenullable

delivery_condition

object

id int32nullable

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

no stringnullable

notes stringnullable

memo stringnullable

org

object

name stringnullable

reg_no stringnullable

tax_no stringnullable

vat_no stringnullable

eori_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

info_legal stringnullable

config

object

logo stringnullable

signature stringnullable

website stringnullable

email stringnullable

phone stringnullable

fb stringnullable

insta stringnullable

payment_reference stringnullable

payment_info stringnullable

payment_term

object

id int32nullable

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

precision int32

Default value: 2

rate_format stringnullable

taxes_included boolean

fx_rate doublenullable

tax_fx_rate doublenullable

shipping_address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable

template_layout stringnullable

document_locale stringnullable

type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable

payment_status stringnullable

overdue_days int32nullable

shopify_object_id int64nullable

woocommerce_order_id int64nullable

eshop_order_id int64nullable

purchase_order

object

id int64nullable

no stringnullable

ext_id stringnullable

url stringnullable

payment_status stringnullable

fulfillment_status stringnullable

sales_order

object

id int64nullable

no stringnullable

ext_id stringnullable

url stringnullable

payment_status stringnullable

fulfillment_status stringnullable

items

object[]

nullable

Array [

id int64nullable

title stringnullable

description stringnullable

qty double

rate doublenullable

rate_discounted doublenullable

discount_explicit doublenullable

discount_implicit doublenullable

amount doublenullable

total_taxes_amount doublenullable

total_taxes_rate doublenullable

shopify_line_id int64nullable

stripe_object_id stringnullable

woocommerce_line_id int64nullable

eshop_line_id int64nullable

sku stringnullable

barcode stringnullable

country_of_origin stringnullable

harmonized_system_code stringnullable

weight_grams doublenullable

requires_shipping boolean

item

object

id int64

sku stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

variant

object

id int64

name stringnullable

unit

object

id int32nullable

code stringnullable

unece_code stringnullable

symbol_org stringnullable

symbol_leg stringnullable

symbol stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

currency_leg stringnullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

]

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

currency_leg stringnullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

shipping_charges

object[]

nullable

Array [

id int64nullable

title stringnullable

amount doublenullable

discount_implicit doublenullable

shopify_line_id int64nullable

stripe_object_id stringnullable

woocommerce_line_id int64nullable

eshop_line_id int64nullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

currency_leg stringnullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

]

discounts

object[]

nullable

Array [

title stringnullable

amount double

value doublenullable

value_type stringnullable

allocation_method stringnullable

target_type stringnullable

]

urls

object[]

nullable

Array [

token stringnullable

expire_at date-timenullable

url stringnullable

]

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "edited_at": "2024-07-29T15:51:28.071Z",
      "is_locked": true,
      "total_amount": 0,
      "subtotal_amount": 0,
      "amount_paid": 0,
      "amount_due": 0,
      "total_items_amount": 0,
      "total_taxes_amount": 0,
      "total_taxes_rate": 0,
      "bank_account": {
        "id": 0,
        "account_number": "string"
      },
      "billing_address": {
        "name": "string",
        "company": "string",
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "region": "string",
        "country": "string"
      },
      "counter_id": 0,
      "currency": "string",
      "customer": {
        "id": 0,
        "business_name": "string",
        "display_name": "string",
        "reg_no": "string",
        "vat_no": "string",
        "tax_no": "string",
        "address": {
          "name": "string",
          "company": "string",
          "address1": "string",
          "address2": "string",
          "postal_code": "string",
          "city": "string",
          "region": "string",
          "country": "string"
        },
        "email": "string",
        "preferred_locale": "string",
        "phone": "string"
      },
      "culture": "string",
      "date_issued": "2024-07-29",
      "date_taxable": "2024-07-29",
      "date_due": "2024-07-29",
      "delivery_condition": {
        "id": 0,
        "code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string"
      },
      "no": "string",
      "notes": "string",
      "memo": "string",
      "org": {
        "name": "string",
        "reg_no": "string",
        "tax_no": "string",
        "vat_no": "string",
        "eori_no": "string",
        "address": {
          "name": "string",
          "company": "string",
          "address1": "string",
          "address2": "string",
          "postal_code": "string",
          "city": "string",
          "region": "string",
          "country": "string"
        },
        "info_legal": "string",
        "config": {
          "logo": "string",
          "signature": "string"
        },
        "website": "string",
        "email": "string",
        "phone": "string",
        "fb": "string",
        "insta": "string"
      },
      "payment_reference": "string",
      "payment_info": "string",
      "payment_term": {
        "id": 0,
        "code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string"
      },
      "precision": 2,
      "rate_format": "string",
      "taxes_included": true,
      "fx_rate": 0,
      "tax_fx_rate": 0,
      "shipping_address": {
        "name": "string",
        "company": "string",
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "region": "string",
        "country": "string"
      },
      "tax_nexus": {
        "id": 0,
        "code": "string",
        "currency": "string",
        "taxes": [
          {
            "index": 0,
            "code": "string",
            "name": "string",
            "currency": "string",
            "rate_type": "string",
            "is_implicit": true,
            "rates": [
              {
                "rate": 0,
                "is_default": true
              }
            ]
          }
        ],
        "jurisdiction": {
          "country": "string",
          "region": "string",
          "subregion": "string",
          "city": "string",
          "postal_code": "string"
        },
        "registration_mode": "string"
      },
      "template_layout": "string",
      "document_locale": "string",
      "type": {
        "id": 0,
        "name": "string",
        "associated_payment_cards": [
          "string"
        ]
      },
      "payment_status": "string",
      "overdue_days": 0,
      "shopify_object_id": 0,
      "woocommerce_order_id": 0,
      "eshop_order_id": 0,
      "purchase_order": {
        "id": 0,
        "no": "string",
        "ext_id": "string",
        "url": "string",
        "payment_status": "string",
        "fulfillment_status": "string"
      },
      "sales_order": {
        "id": 0,
        "no": "string",
        "ext_id": "string",
        "url": "string",
        "payment_status": "string",
        "fulfillment_status": "string"
      },
      "items": [
        {
          "id": 0,
          "title": "string",
          "description": "string",
          "qty": 0,
          "rate": 0,
          "rate_discounted": 0,
          "discount_explicit": 0,
          "discount_implicit": 0,
          "amount": 0,
          "total_taxes_amount": 0,
          "total_taxes_rate": 0,
          "shopify_line_id": 0,
          "stripe_object_id": "string",
          "woocommerce_line_id": 0,
          "eshop_line_id": 0,
          "sku": "string",
          "barcode": "string",
          "country_of_origin": "string",
          "harmonized_system_code": "string",
          "weight_grams": 0,
          "requires_shipping": true,
          "item": {
            "id": 0,
            "sku": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string",
            "desc_org": "string",
            "desc_leg": "string",
            "desc": "string"
          },
          "variant": {
            "id": 0,
            "name": "string"
          },
          "unit": {
            "id": 0,
            "code": "string",
            "unece_code": "string",
            "symbol_org": "string",
            "symbol_leg": "string",
            "symbol": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string"
          },
          "taxes": [
            {
              "id": 0,
              "tax_rate": 0,
              "tax_amount": 0,
              "tax_amount_leg": 0,
              "tax_base": 0,
              "tax_base_leg": 0,
              "currency_leg": "string",
              "tax_index": 0,
              "tax_code": "string",
              "tax_name": "string",
              "rate_type": "string"
            }
          ]
        }
      ],
      "taxes": [
        {
          "id": 0,
          "tax_rate": 0,
          "tax_amount": 0,
          "tax_amount_leg": 0,
          "tax_base": 0,
          "tax_base_leg": 0,
          "currency_leg": "string",
          "tax_index": 0,
          "tax_code": "string",
          "tax_name": "string",
          "rate_type": "string"
        }
      ],
      "shipping_charges": [
        {
          "id": 0,
          "title": "string",
          "amount": 0,
          "discount_implicit": 0,
          "shopify_line_id": 0,
          "stripe_object_id": "string",
          "woocommerce_line_id": 0,
          "eshop_line_id": 0,
          "taxes": [
            {
              "id": 0,
              "tax_rate": 0,
              "tax_amount": 0,
              "tax_amount_leg": 0,
              "tax_base": 0,
              "tax_base_leg": 0,
              "currency_leg": "string",
              "tax_index": 0,
              "tax_code": "string",
              "tax_name": "string",
              "rate_type": "string"
            }
          ]
        }
      ],
      "discounts": [
        {
          "title": "string",
          "amount": 0,
          "value": 0,
          "value_type": "string",
          "allocation_method": "string",
          "target_type": "string"
        }
      ],
      "urls": [
        {
          "token": "string",
          "expire_at": "2024-07-29T15:51:28.071Z",
          "url": "string"
        }
      ]
    }
  ],
  "aggregations": [
    null
  ]
}

application/json

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuidnullable

created_at date-timenullable

edited_at date-timenullable

is_locked boolean

total_amount doublenullable

subtotal_amount doublenullable

amount_paid doublenullable

amount_due doublenullable

total_items_amount doublenullable

total_taxes_amount doublenullable

total_taxes_rate doublenullable

bank_account

object

id int32nullable

account_number stringnullable

billing_address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

counter_id int32nullable

currency stringnullable

Possible values: <= 3 characters

customer

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable

culture stringnullable

date_issued datenullable

date_taxable datenullable

date_due datenullable

delivery_condition

object

id int32nullable

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

no stringnullable

notes stringnullable

memo stringnullable

org

object

name stringnullable

reg_no stringnullable

tax_no stringnullable

vat_no stringnullable

eori_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

info_legal stringnullable

config

object

logo stringnullable

signature stringnullable

website stringnullable

email stringnullable

phone stringnullable

fb stringnullable

insta stringnullable

payment_reference stringnullable

payment_info stringnullable

payment_term

object

id int32nullable

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

precision int32

Default value: 2

rate_format stringnullable

taxes_included boolean

fx_rate doublenullable

tax_fx_rate doublenullable

shipping_address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable

template_layout stringnullable

document_locale stringnullable

type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable

payment_status stringnullable

overdue_days int32nullable

shopify_object_id int64nullable

woocommerce_order_id int64nullable

eshop_order_id int64nullable

purchase_order

object

id int64nullable

no stringnullable

ext_id stringnullable

url stringnullable

payment_status stringnullable

fulfillment_status stringnullable

sales_order

object

id int64nullable

no stringnullable

ext_id stringnullable

url stringnullable

payment_status stringnullable

fulfillment_status stringnullable

items

object[]

nullable

Array [

id int64nullable

title stringnullable

description stringnullable

qty double

rate doublenullable

rate_discounted doublenullable

discount_explicit doublenullable

discount_implicit doublenullable

amount doublenullable

total_taxes_amount doublenullable

total_taxes_rate doublenullable

shopify_line_id int64nullable

stripe_object_id stringnullable

woocommerce_line_id int64nullable

eshop_line_id int64nullable

sku stringnullable

barcode stringnullable

country_of_origin stringnullable

harmonized_system_code stringnullable

weight_grams doublenullable

requires_shipping boolean

item

object

id int64

sku stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

variant

object

id int64

name stringnullable

unit

object

id int32nullable

code stringnullable

unece_code stringnullable

symbol_org stringnullable

symbol_leg stringnullable

symbol stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

currency_leg stringnullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

]

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

currency_leg stringnullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

shipping_charges

object[]

nullable

Array [

id int64nullable

title stringnullable

amount doublenullable

discount_implicit doublenullable

shopify_line_id int64nullable

stripe_object_id stringnullable

woocommerce_line_id int64nullable

eshop_line_id int64nullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

currency_leg stringnullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

]

discounts

object[]

nullable

Array [

title stringnullable

amount double

value doublenullable

value_type stringnullable

allocation_method stringnullable

target_type stringnullable

]

urls

object[]

nullable

Array [

token stringnullable

expire_at date-timenullable

url stringnullable

]

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "edited_at": "2024-07-29T15:51:28.071Z",
      "is_locked": true,
      "total_amount": 0,
      "subtotal_amount": 0,
      "amount_paid": 0,
      "amount_due": 0,
      "total_items_amount": 0,
      "total_taxes_amount": 0,
      "total_taxes_rate": 0,
      "bank_account": {
        "id": 0,
        "account_number": "string"
      },
      "billing_address": {
        "name": "string",
        "company": "string",
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "region": "string",
        "country": "string"
      },
      "counter_id": 0,
      "currency": "string",
      "customer": {
        "id": 0,
        "business_name": "string",
        "display_name": "string",
        "reg_no": "string",
        "vat_no": "string",
        "tax_no": "string",
        "address": {
          "name": "string",
          "company": "string",
          "address1": "string",
          "address2": "string",
          "postal_code": "string",
          "city": "string",
          "region": "string",
          "country": "string"
        },
        "email": "string",
        "preferred_locale": "string",
        "phone": "string"
      },
      "culture": "string",
      "date_issued": "2024-07-29",
      "date_taxable": "2024-07-29",
      "date_due": "2024-07-29",
      "delivery_condition": {
        "id": 0,
        "code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string"
      },
      "no": "string",
      "notes": "string",
      "memo": "string",
      "org": {
        "name": "string",
        "reg_no": "string",
        "tax_no": "string",
        "vat_no": "string",
        "eori_no": "string",
        "address": {
          "name": "string",
          "company": "string",
          "address1": "string",
          "address2": "string",
          "postal_code": "string",
          "city": "string",
          "region": "string",
          "country": "string"
        },
        "info_legal": "string",
        "config": {
          "logo": "string",
          "signature": "string"
        },
        "website": "string",
        "email": "string",
        "phone": "string",
        "fb": "string",
        "insta": "string"
      },
      "payment_reference": "string",
      "payment_info": "string",
      "payment_term": {
        "id": 0,
        "code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string"
      },
      "precision": 2,
      "rate_format": "string",
      "taxes_included": true,
      "fx_rate": 0,
      "tax_fx_rate": 0,
      "shipping_address": {
        "name": "string",
        "company": "string",
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "region": "string",
        "country": "string"
      },
      "tax_nexus": {
        "id": 0,
        "code": "string",
        "currency": "string",
        "taxes": [
          {
            "index": 0,
            "code": "string",
            "name": "string",
            "currency": "string",
            "rate_type": "string",
            "is_implicit": true,
            "rates": [
              {
                "rate": 0,
                "is_default": true
              }
            ]
          }
        ],
        "jurisdiction": {
          "country": "string",
          "region": "string",
          "subregion": "string",
          "city": "string",
          "postal_code": "string"
        },
        "registration_mode": "string"
      },
      "template_layout": "string",
      "document_locale": "string",
      "type": {
        "id": 0,
        "name": "string",
        "associated_payment_cards": [
          "string"
        ]
      },
      "payment_status": "string",
      "overdue_days": 0,
      "shopify_object_id": 0,
      "woocommerce_order_id": 0,
      "eshop_order_id": 0,
      "purchase_order": {
        "id": 0,
        "no": "string",
        "ext_id": "string",
        "url": "string",
        "payment_status": "string",
        "fulfillment_status": "string"
      },
      "sales_order": {
        "id": 0,
        "no": "string",
        "ext_id": "string",
        "url": "string",
        "payment_status": "string",
        "fulfillment_status": "string"
      },
      "items": [
        {
          "id": 0,
          "title": "string",
          "description": "string",
          "qty": 0,
          "rate": 0,
          "rate_discounted": 0,
          "discount_explicit": 0,
          "discount_implicit": 0,
          "amount": 0,
          "total_taxes_amount": 0,
          "total_taxes_rate": 0,
          "shopify_line_id": 0,
          "stripe_object_id": "string",
          "woocommerce_line_id": 0,
          "eshop_line_id": 0,
          "sku": "string",
          "barcode": "string",
          "country_of_origin": "string",
          "harmonized_system_code": "string",
          "weight_grams": 0,
          "requires_shipping": true,
          "item": {
            "id": 0,
            "sku": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string",
            "desc_org": "string",
            "desc_leg": "string",
            "desc": "string"
          },
          "variant": {
            "id": 0,
            "name": "string"
          },
          "unit": {
            "id": 0,
            "code": "string",
            "unece_code": "string",
            "symbol_org": "string",
            "symbol_leg": "string",
            "symbol": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string"
          },
          "taxes": [
            {
              "id": 0,
              "tax_rate": 0,
              "tax_amount": 0,
              "tax_amount_leg": 0,
              "tax_base": 0,
              "tax_base_leg": 0,
              "currency_leg": "string",
              "tax_index": 0,
              "tax_code": "string",
              "tax_name": "string",
              "rate_type": "string"
            }
          ]
        }
      ],
      "taxes": [
        {
          "id": 0,
          "tax_rate": 0,
          "tax_amount": 0,
          "tax_amount_leg": 0,
          "tax_base": 0,
          "tax_base_leg": 0,
          "currency_leg": "string",
          "tax_index": 0,
          "tax_code": "string",
          "tax_name": "string",
          "rate_type": "string"
        }
      ],
      "shipping_charges": [
        {
          "id": 0,
          "title": "string",
          "amount": 0,
          "discount_implicit": 0,
          "shopify_line_id": 0,
          "stripe_object_id": "string",
          "woocommerce_line_id": 0,
          "eshop_line_id": 0,
          "taxes": [
            {
              "id": 0,
              "tax_rate": 0,
              "tax_amount": 0,
              "tax_amount_leg": 0,
              "tax_base": 0,
              "tax_base_leg": 0,
              "currency_leg": "string",
              "tax_index": 0,
              "tax_code": "string",
              "tax_name": "string",
              "rate_type": "string"
            }
          ]
        }
      ],
      "discounts": [
        {
          "title": "string",
          "amount": 0,
          "value": 0,
          "value_type": "string",
          "allocation_method": "string",
          "target_type": "string"
        }
      ],
      "urls": [
        {
          "token": "string",
          "expire_at": "2024-07-29T15:51:28.071Z",
          "url": "string"
        }
      ]
    }
  ],
  "aggregations": [
    null
  ]
}

text/json

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuidnullable

created_at date-timenullable

edited_at date-timenullable

is_locked boolean

total_amount doublenullable

subtotal_amount doublenullable

amount_paid doublenullable

amount_due doublenullable

total_items_amount doublenullable

total_taxes_amount doublenullable

total_taxes_rate doublenullable

bank_account

object

id int32nullable

account_number stringnullable

billing_address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

counter_id int32nullable

currency stringnullable

Possible values: <= 3 characters

customer

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable

culture stringnullable

date_issued datenullable

date_taxable datenullable

date_due datenullable

delivery_condition

object

id int32nullable

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

no stringnullable

notes stringnullable

memo stringnullable

org

object

name stringnullable

reg_no stringnullable

tax_no stringnullable

vat_no stringnullable

eori_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

info_legal stringnullable

config

object

logo stringnullable

signature stringnullable

website stringnullable

email stringnullable

phone stringnullable

fb stringnullable

insta stringnullable

payment_reference stringnullable

payment_info stringnullable

payment_term

object

id int32nullable

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

precision int32

Default value: 2

rate_format stringnullable

taxes_included boolean

fx_rate doublenullable

tax_fx_rate doublenullable

shipping_address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable

template_layout stringnullable

document_locale stringnullable

type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable

payment_status stringnullable

overdue_days int32nullable

shopify_object_id int64nullable

woocommerce_order_id int64nullable

eshop_order_id int64nullable

purchase_order

object

id int64nullable

no stringnullable

ext_id stringnullable

url stringnullable

payment_status stringnullable

fulfillment_status stringnullable

sales_order

object

id int64nullable

no stringnullable

ext_id stringnullable

url stringnullable

payment_status stringnullable

fulfillment_status stringnullable

items

object[]

nullable

Array [

id int64nullable

title stringnullable

description stringnullable

qty double

rate doublenullable

rate_discounted doublenullable

discount_explicit doublenullable

discount_implicit doublenullable

amount doublenullable

total_taxes_amount doublenullable

total_taxes_rate doublenullable

shopify_line_id int64nullable

stripe_object_id stringnullable

woocommerce_line_id int64nullable

eshop_line_id int64nullable

sku stringnullable

barcode stringnullable

country_of_origin stringnullable

harmonized_system_code stringnullable

weight_grams doublenullable

requires_shipping boolean

item

object

id int64

sku stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

variant

object

id int64

name stringnullable

unit

object

id int32nullable

code stringnullable

unece_code stringnullable

symbol_org stringnullable

symbol_leg stringnullable

symbol stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

currency_leg stringnullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

]

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

currency_leg stringnullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

shipping_charges

object[]

nullable

Array [

id int64nullable

title stringnullable

amount doublenullable

discount_implicit doublenullable

shopify_line_id int64nullable

stripe_object_id stringnullable

woocommerce_line_id int64nullable

eshop_line_id int64nullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

currency_leg stringnullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

]

discounts

object[]

nullable

Array [

title stringnullable

amount double

value doublenullable

value_type stringnullable

allocation_method stringnullable

target_type stringnullable

]

urls

object[]

nullable

Array [

token stringnullable

expire_at date-timenullable

url stringnullable

]

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "edited_at": "2024-07-29T15:51:28.071Z",
      "is_locked": true,
      "total_amount": 0,
      "subtotal_amount": 0,
      "amount_paid": 0,
      "amount_due": 0,
      "total_items_amount": 0,
      "total_taxes_amount": 0,
      "total_taxes_rate": 0,
      "bank_account": {
        "id": 0,
        "account_number": "string"
      },
      "billing_address": {
        "name": "string",
        "company": "string",
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "region": "string",
        "country": "string"
      },
      "counter_id": 0,
      "currency": "string",
      "customer": {
        "id": 0,
        "business_name": "string",
        "display_name": "string",
        "reg_no": "string",
        "vat_no": "string",
        "tax_no": "string",
        "address": {
          "name": "string",
          "company": "string",
          "address1": "string",
          "address2": "string",
          "postal_code": "string",
          "city": "string",
          "region": "string",
          "country": "string"
        },
        "email": "string",
        "preferred_locale": "string",
        "phone": "string"
      },
      "culture": "string",
      "date_issued": "2024-07-29",
      "date_taxable": "2024-07-29",
      "date_due": "2024-07-29",
      "delivery_condition": {
        "id": 0,
        "code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string"
      },
      "no": "string",
      "notes": "string",
      "memo": "string",
      "org": {
        "name": "string",
        "reg_no": "string",
        "tax_no": "string",
        "vat_no": "string",
        "eori_no": "string",
        "address": {
          "name": "string",
          "company": "string",
          "address1": "string",
          "address2": "string",
          "postal_code": "string",
          "city": "string",
          "region": "string",
          "country": "string"
        },
        "info_legal": "string",
        "config": {
          "logo": "string",
          "signature": "string"
        },
        "website": "string",
        "email": "string",
        "phone": "string",
        "fb": "string",
        "insta": "string"
      },
      "payment_reference": "string",
      "payment_info": "string",
      "payment_term": {
        "id": 0,
        "code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string"
      },
      "precision": 2,
      "rate_format": "string",
      "taxes_included": true,
      "fx_rate": 0,
      "tax_fx_rate": 0,
      "shipping_address": {
        "name": "string",
        "company": "string",
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "region": "string",
        "country": "string"
      },
      "tax_nexus": {
        "id": 0,
        "code": "string",
        "currency": "string",
        "taxes": [
          {
            "index": 0,
            "code": "string",
            "name": "string",
            "currency": "string",
            "rate_type": "string",
            "is_implicit": true,
            "rates": [
              {
                "rate": 0,
                "is_default": true
              }
            ]
          }
        ],
        "jurisdiction": {
          "country": "string",
          "region": "string",
          "subregion": "string",
          "city": "string",
          "postal_code": "string"
        },
        "registration_mode": "string"
      },
      "template_layout": "string",
      "document_locale": "string",
      "type": {
        "id": 0,
        "name": "string",
        "associated_payment_cards": [
          "string"
        ]
      },
      "payment_status": "string",
      "overdue_days": 0,
      "shopify_object_id": 0,
      "woocommerce_order_id": 0,
      "eshop_order_id": 0,
      "purchase_order": {
        "id": 0,
        "no": "string",
        "ext_id": "string",
        "url": "string",
        "payment_status": "string",
        "fulfillment_status": "string"
      },
      "sales_order": {
        "id": 0,
        "no": "string",
        "ext_id": "string",
        "url": "string",
        "payment_status": "string",
        "fulfillment_status": "string"
      },
      "items": [
        {
          "id": 0,
          "title": "string",
          "description": "string",
          "qty": 0,
          "rate": 0,
          "rate_discounted": 0,
          "discount_explicit": 0,
          "discount_implicit": 0,
          "amount": 0,
          "total_taxes_amount": 0,
          "total_taxes_rate": 0,
          "shopify_line_id": 0,
          "stripe_object_id": "string",
          "woocommerce_line_id": 0,
          "eshop_line_id": 0,
          "sku": "string",
          "barcode": "string",
          "country_of_origin": "string",
          "harmonized_system_code": "string",
          "weight_grams": 0,
          "requires_shipping": true,
          "item": {
            "id": 0,
            "sku": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string",
            "desc_org": "string",
            "desc_leg": "string",
            "desc": "string"
          },
          "variant": {
            "id": 0,
            "name": "string"
          },
          "unit": {
            "id": 0,
            "code": "string",
            "unece_code": "string",
            "symbol_org": "string",
            "symbol_leg": "string",
            "symbol": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string"
          },
          "taxes": [
            {
              "id": 0,
              "tax_rate": 0,
              "tax_amount": 0,
              "tax_amount_leg": 0,
              "tax_base": 0,
              "tax_base_leg": 0,
              "currency_leg": "string",
              "tax_index": 0,
              "tax_code": "string",
              "tax_name": "string",
              "rate_type": "string"
            }
          ]
        }
      ],
      "taxes": [
        {
          "id": 0,
          "tax_rate": 0,
          "tax_amount": 0,
          "tax_amount_leg": 0,
          "tax_base": 0,
          "tax_base_leg": 0,
          "currency_leg": "string",
          "tax_index": 0,
          "tax_code": "string",
          "tax_name": "string",
          "rate_type": "string"
        }
      ],
      "shipping_charges": [
        {
          "id": 0,
          "title": "string",
          "amount": 0,
          "discount_implicit": 0,
          "shopify_line_id": 0,
          "stripe_object_id": "string",
          "woocommerce_line_id": 0,
          "eshop_line_id": 0,
          "taxes": [
            {
              "id": 0,
              "tax_rate": 0,
              "tax_amount": 0,
              "tax_amount_leg": 0,
              "tax_base": 0,
              "tax_base_leg": 0,
              "currency_leg": "string",
              "tax_index": 0,
              "tax_code": "string",
              "tax_name": "string",
              "rate_type": "string"
            }
          ]
        }
      ],
      "discounts": [
        {
          "title": "string",
          "amount": 0,
          "value": 0,
          "value_type": "string",
          "allocation_method": "string",
          "target_type": "string"
        }
      ],
      "urls": [
        {
          "token": "string",
          "expire_at": "2024-07-29T15:51:28.071Z",
          "url": "string"
        }
      ]
    }
  ],
  "aggregations": [
    null
  ]
}

Loading...