Sign in
Quotes

Get Quote

Get Quote

get/accounting/quotes/{id}

Path parameters

idstring required

ID of the record you are acting upon.

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Response

Quotes

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "Quotes",
  "operation": "one",
  "data": {
    "id": "12345",
    "downstream_id": "12345",
    "number": "QT00546",
    "customer": {
      "id": "12345",
      "display_id": "CUST00101",
      "display_name": "Windsurf Shop",
      "name": "Windsurf Shop",
      "company_name": "The boring company",
      "email": "boring@boring.com"
    },
    "invoice_id": "123456",
    "sales_order_id": "123456",
    "company_id": "12345",
    "department_id": "12345",
    "project_id": "12345",
    "quote_date": "2020-09-30",
    "expiry_date": "2020-10-30",
    "terms": "Valid for 30 days",
    "terms_id": "12345",
    "reference": "INV-2024-001",
    "status": "draft",
    "currency": "USD",
    "currency_rate": 0.69,
    "tax_inclusive": true,
    "sub_total": 27500,
    "total_tax": 2500,
    "tax_code": "1234",
    "discount_percentage": 5.5,
    "discount_amount": 25,
    "total": 27500,
    "customer_memo": "Thank you for considering our services!",
    "line_items": [
      {
        "id": "12345",
        "row_id": "12345",
        "code": "120-C",
        "line_number": 1,
        "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
        "type": "sales_item",
        "tax_amount": 27500,
        "total_amount": 27500,
        "quantity": 1,
        "unit_price": 27500.5,
        "unit_of_measure": "pc.",
        "discount_percentage": 0.01,
        "discount_amount": 19.99,
        "service_date": "2024-01-15",
        "category_id": "12345",
        "location_id": "12345",
        "department_id": "12345",
        "item": {
          "id": "12344",
          "code": "120-C",
          "name": "Model Y"
        },
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases",
          "rate": 10
        },
        "tracking_categories": [
          {
            "id": "123456",
            "code": "100",
            "name": "New York",
            "parent_id": "123456",
            "parent_name": "New York"
          }
        ],
        "ledger_account": {
          "id": "123456",
          "name": "Bank account",
          "nominal_code": "N091",
          "code": "453",
          "parent_id": "123456",
          "display_id": "123456"
        },
        "custom_fields": [
          {
            "id": "2389328923893298",
            "name": "employee_level",
            "ref_name": "Marketing",
            "description": "Employee Level",
            "value": "Uses Salesforce and Marketo"
          }
        ],
        "row_version": "1-12345",
        "updated_by": "12345",
        "created_by": "12345",
        "created_at": "2020-09-30T07:43:32.000Z",
        "updated_at": "2020-09-30T07:43:32.000Z"
      }
    ],
    "billing_address": {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "line5": "Attention: Finance Dept",
      "street_number": "25",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638",
      "county": "Santa Clara",
      "contact_name": "Elon Musk",
      "salutation": "Mr",
      "phone_number": "111-111-1111",
      "fax": "122-111-1111",
      "email": "elon@musk.com",
      "website": "https://elonmusk.com",
      "notes": "Address notes or delivery instructions.",
      "row_version": "1-12345"
    },
    "shipping_address": {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "line5": "Attention: Finance Dept",
      "street_number": "25",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638",
      "county": "Santa Clara",
      "contact_name": "Elon Musk",
      "salutation": "Mr",
      "phone_number": "111-111-1111",
      "fax": "122-111-1111",
      "email": "elon@musk.com",
      "website": "https://elonmusk.com",
      "notes": "Address notes or delivery instructions.",
      "row_version": "1-12345"
    },
    "tracking_categories": [
      {
        "id": "123456",
        "code": "100",
        "name": "New York",
        "parent_id": "123456",
        "parent_name": "New York"
      }
    ],
    "template_id": "123456",
    "source_document_url": "https://www.quotesolution.com/quote/123456",
    "custom_fields": [
      {
        "id": "2389328923893298",
        "name": "employee_level",
        "ref_name": "Marketing",
        "description": "Employee Level",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z",
    "pass_through": [
      {
        "extend_paths": [
          {
            "path": "$.nested.property",
            "value": {
              "TaxClassificationRef": {
                "value": "EUC-99990201-V1-00020000"
              }
            }
          }
        ]
      }
    ]
  },
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  }
}

Changes

Changed in 3 of the 97 revisions of this API.13

  • 17a0dec246722See the full diff
    • ○

      added the optional property data/custom_fields/items/ref_name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/line_items/items/custom_fields/items/ref_name to the response with the 200 status

      response-optional-property-added

  • 3edfec8e990e1See the full diff
    • ○

      added the optional property meta to the response with the 200 status

      response-optional-property-added

  • ae40771256551See the full diff
    • ●

      removed the optional property meta from the response with the 200 status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog