API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

ENDPOINTS

Sandbox: https://invoicedemo.iqmetrix.net/v1
Production: https://invoice.iqmetrix.net/v1

RESOURCES

Invoice

{
    "Id": "418938fe-e3e2-4f66-af01-a485a02a6b09",
    "CreatedByUser": "22212",
    "CreatedDateUtc": "2015-04-23T13:14:12.997",
    "Customer": {
        "Id": "503d1d4a-c974-4286-b4a2-002699e60ad6",
        "AlternateName": "Bob",
        "BillingAddress": {
            "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
            "CountryCode": "CA",
            "DoNotContact": false,
            "Locality": "Mountain View",
            "Notes": "New residence",
            "PostalCode": "94043",
            "PostOfficeBoxNumber": "P.O. Box 1022",
            "StateCode": "AB",
            "StreetAddress1": "1600 Amphitheatre Pkwy",
            "StreetAddress2": "Suite 500"
        },
        "CustomerType": "Person",
        "CustomerTypeId": 2,
        "DateOfBirth": "1952-07-23T12:00:00.000",
        "DoNotContact": false,
        "FamilyName": "Smith",
        "MiddleName": "Lee",
        "Notes": "Interested in iPhone 6",
        "PrimaryName": "Robert",
        "ShippingAddress": {
            "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
            "CountryCode": "CA",
            "DoNotContact": false,
            "Locality": "Mountain View",
            "Notes": "New residence",
            "PostalCode": "94043",
            "PostOfficeBoxNumber": "P.O. Box 1022",
            "StateCode": "AB",
            "StreetAddress1": "1600 Amphitheatre Pkwy",
            "StreetAddress2": "Suite 500"
        },
        "Title": "Mr"
    },
    "DropshipOrders": [
        {
            "Id": "216f7424-ae18-4c69-9597-984b430d0759",
            "Items": [
                {
                    "Id": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
                    "Description": "iPhone 4s",
                    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
                    "Quantity": 1,
                    "SellingPrice": 499,
                    "Sku": "403405"
                }
            ],
            "PrintableId": "8765-1234-987",
            "ReferenceId": "INV112",
            "ShippingEntityId": 4,
            "ShippingMethod": "350",
            "SupplierId": 14107
        }
    ],
    "EmployeeId": 15,
    "IsRefund": false,
    "LocationId": 4,
    "Notes": "Trade in iPhone",
    "Orders": [
        {
            "Id": "216f7424-ae18-4c69-9597-984b430d0759",
            "Items": [
                {
                    "Id": "0fff7fb5-4620-4b81-8199-ec41ba6f0451",
                    "Description": "iPhone 4s",
                    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
                    "Quantity": 1,
                    "SellingPrice": 499,
                    "SerialNumber": "B7FQ-RANC",
                    "Sku": "403405"
                }
            ],
            "PrintableId": "8765-1234-987",
            "ReferenceId": "INV112"
        }
    ],
    "OriginalInvoiceId": "7832c7e8-6b3e-4538-9414-e3ca68058d9f",
    "Payments": [
        {
            "Id": "15215",
            "Amount": 15,
            "DrawerId": "f41b20b2-31cb-4585-aca2-e17b1b1de41e",
            "PaymentMethodId": 4,
            "ReferenceId": "Pay5531",
            "TransactionDate": "2016-01-06T16:22:41.1236641+00:00",
            "TransactionType": "Purchase"
        }
    ],
    "PrintableId": "8765-1234-987",
    "TaxCalculationResult": {
        "Id": "da7409e3-060d-4c98-b3bd-b0cb7a0efa0d",
        "Lines": [
            {
                "LineNumber": "Line1",
                "Discount": 0.51,
                "Rate": 15,
                "Tax": 0.85,
                "Taxability": true,
                "Taxable": 3.99,
                "TaxDetails": [
                    {
                        "TaxId": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
                        "TaxName": "GST",
                        "CountryCode": "CA",
                        "Rate": 15,
                        "RegionCode": "AB",
                        "Tax": 3.99,
                        "Taxable": 3.99,
                        "TaxAuthority": "CRA",
                        "TaxAuthorityType": "Canada",
                        "TaxCategory": "Goods and Sales",
                        "TaxType": "Provincial"
                    }
                ]
            }
        ]
    }
}
Name Description
Id (GUID) Unique identifier
CreatedByUser (String) Auditing column, the identifier of the User that created this Invoice
CreatedDateUtc (DateTime) Date the invoice was created, in UTC
Customer (Customer) The person or organization this Invoice belongs to
DropshipOrders (Array[DropshipOrder]) Collection of Dropship Orders on the Invoice
EmployeeId (Integer) Identifier of the Employee associated with the invoice
IsRefund (Boolean) A flag to indicate if this is a Refund
LocationId (Integer) Identifier of the Location associated with this Invoice
Notes (String) Notes
Orders (Array[Order]) Collection of Orders on the Invoice
OriginalInvoiceId (GUID) Unique identifier for the original invoice, in the case of a refund
Payments (Array[Payment]) Collection of Payments on the Invoice
PrintableId (String) An identifier that can used to print on invoices
TaxCalculationResult (TaxCalculationResult) Taxes for the Invoice

InvoiceSummary

{
    "Id": "418938fe-e3e2-4f66-af01-a485a02a6b09",
    "CreatedDateUtc": "2016-01-18T15:56:23.2526213Z",
    "CustomerId": "503d1d4a-c974-4286-b4a2-002699e60ad6",
    "EmployeeId": 15,
    "InvoiceTotal": 59.99,
    "InvoiceType": "None",
    "LocationId": 4,
    "PrintableId": "8765-1234-987"
}
Name Description  
Id (GUID) Unique identifier for an Invoice  
CreatedDateUtc (DateTime) Date the invoice was created, in UTC  
CustomerId (GUID) Identifier for the Customer  
EmployeeId (Integer) Identifier of the Employee associated with the invoice  
InvoiceTotal (Decimal) Total amount on the Invoice  
InvoiceType (String) A string describing Invoice. Acceptable values are: None, Purchase, Refund  
LocationId (Integer) Identifier of the Location associated with this Invoice  
PrintableId (String) An identifier for this Order that can used to print on invoices  
PaymentTypes (String) Reserved for future use  

Customer

{
    "Id": "503d1d4a-c974-4286-b4a2-002699e60ad6",
    "AlternateName": "Bob",
    "BillingAddress": {
        "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
        "CountryCode": "CA",
        "DoNotContact": false,
        "Locality": "Mountain View",
        "Notes": "New residence",
        "PostalCode": "94043",
        "PostOfficeBoxNumber": "P.O. Box 1022",
        "StateCode": "AB",
        "StreetAddress1": "1600 Amphitheatre Pkwy",
        "StreetAddress2": "Suite 500"
    },
    "CustomerType": "Person",
    "CustomerTypeId": 2,
    "DateOfBirth": "1952-07-23T12:00:00.000",
    "DoNotContact": false,
    "FamilyName": "Smith",
    "MiddleName": "Lee",
    "Notes": "Interested in iPhone 6",
    "PrimaryName": "Robert",
    "ShippingAddress": {
        "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
        "CountryCode": "CA",
        "DoNotContact": false,
        "Locality": "Mountain View",
        "Notes": "New residence",
        "PostalCode": "94043",
        "PostOfficeBoxNumber": "P.O. Box 1022",
        "StateCode": "AB",
        "StreetAddress1": "1600 Amphitheatre Pkwy",
        "StreetAddress2": "Suite 500"
    },
    "Title": "Mr"
}
Name Description
Id (GUID) Unique identifier
AlternateName (String) Alias or preferred name
BillingAddress (Address) Billing Address
CustomerType (String) Name of the CustomerType
CustomerTypeId (Integer) See CustomerType for a list of acceptable values
DateOfBirth (DateTime) Customer’s birth date, stored in UTC but can be provided in shortened form (yyyy-mm-dd)
DoNotContact (Boolean) A flag to indicate if this Customer is private and not to be used by external systems (such as a marketing system), defaults to false
FamilyName (String) Family name. In the U.S., the last name of a Person
MiddleName (String) Middle name. Could also be referred to as Additional name
Notes (String) Any notes related to this Customer
PrimaryName (String) First name of a given person or the full name of the business, division, organization, etc
ShippingAddress (Address) Shipping Address
Title (String) Title

Address

{
    "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
    "CountryCode": "CA",
    "DoNotContact": false,
    "Locality": "Mountain View",
    "Notes": "New residence",
    "PostalCode": "94043",
    "PostOfficeBoxNumber": "P.O. Box 1022",
    "StateCode": "AB",
    "StreetAddress1": "1600 Amphitheatre Pkwy",
    "StreetAddress2": "Suite 500"
}
Name Description
Id (GUID) Unique identifier
CountryCode (String) Country in which this address resides. Uses the ISO 3166-1 alpha-2 standard. For a list of acceptable codes, see Getting All Countries
DoNotContact (Boolean) A flag to indicate if the address is private and not to be used by any external systems (such as a marketing system)
Locality (String) City, Town, Hamlet
Notes (String) Notes related to this Address
PostalCode (String) The postal code/zip code
PostOfficeBoxNumber (String) The post office box number for PO box addresses
StateCode (String) Code for the State in which this address resides. Based off the ISO 3166-2 standard. For a list of acceptable codes, see Getting All Countries
StreetAddress1 (String) The street address
StreetAddress2 (String) The street address

Order

{
    "Id": "216f7424-ae18-4c69-9597-984b430d0759",
    "Items": [
        {
            "Id": "0fff7fb5-4620-4b81-8199-ec41ba6f0451",
            "Description": "iPhone 4s",
            "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
            "Quantity": 1,
            "SellingPrice": 499,
            "SerialNumber": "B7FQ-RANC",
            "Sku": "403405"
        }
    ],
    "PrintableId": "8765-1234-987",
    "ReferenceId": "INV112"
}
Name Description
Id (GUID) Unique identifier
Items (Array[OrderItem]) Items in the Order
PrintableId (String) An identifier that can used to print on invoices
ReferenceId (String) Identifier for an Order in an external system

OrderItem

{
    "Id": "0fff7fb5-4620-4b81-8199-ec41ba6f0451",
    "Description": "iPhone 4s",
    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
    "Quantity": 1,
    "SellingPrice": 499,
    "SerialNumber": "B7FQ-RANC",
    "Sku": "403405"
}
Name Description
Id (GUID) Unique identifier
Description (String) Description
ProductId (GUID) Identifier of a CatalogItem
Quantity (Integer) Quantity
SellingPrice (Decimal) Selling price for a single item
SerialNumber (String) Serial Number for the Item
Sku (String) SKU

DropshipOrder

{
    "Id": "216f7424-ae18-4c69-9597-984b430d0759",
    "Items": [
        {
            "Id": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
            "Description": "iPhone 4s",
            "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
            "Quantity": 1,
            "SellingPrice": 499,
            "Sku": "403405"
        }
    ],
    "PrintableId": "8765-1234-987",
    "ReferenceId": "INV112",
    "ShippingEntityId": 4,
    "ShippingMethod": "350",
    "SupplierId": 14107
}
Name Description
Id (GUID) Unique identifier
Items (Array[DropshipOrderItem]) Items in the Order
PrintableId (String) An identifier for this Order that can used to print on invoices
ReferenceId (String) Identifier for an Order in an external system
ShippingEntityId (Integer) Identifier of the EntityId this Order will be Shipped to, for pick up in store
ShippingMethod (String) Shipping Method chosen, provided by Supplier. See Getting Shipping Options
SupplierId (Integer) Identifier for the Supplier

DropshipOrderItem

{
    "Id": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
    "Description": "iPhone 4s",
    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
    "Quantity": 1,
    "SellingPrice": 499,
    "Sku": "403405"
}
Name Description
Id (GUID) Unique Identifier
Description (String) Description
ProductId (GUID) Identifier of a CatalogItem
Quantity (Integer) Quantity
SellingPrice (Decimal) Selling price for a single item
Sku (String) SKU

TaxCalculationResult

{
    "Id": "da7409e3-060d-4c98-b3bd-b0cb7a0efa0d",
    "Lines": [
        {
            "LineNumber": "Line1",
            "Discount": 0.51,
            "Rate": 15,
            "Tax": 0.85,
            "Taxability": true,
            "Taxable": 3.99,
            "TaxDetails": [
                {
                    "TaxId": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
                    "TaxName": "GST",
                    "CountryCode": "CA",
                    "Rate": 15,
                    "RegionCode": "AB",
                    "Tax": 3.99,
                    "Taxable": 3.99,
                    "TaxAuthority": "CRA",
                    "TaxAuthorityType": "Canada",
                    "TaxCategory": "Goods and Sales",
                    "TaxType": "Provincial"
                }
            ]
        }
    ]
}
Name Description
Id (GUID) Unique identifier
Lines (Array[TaxLineItem]) Tax Lines

TaxLineItem

A tax line item, including the tax calculation results.

{
    "LineNumber": "Line1",
    "Discount": 0.51,
    "Rate": 15,
    "Tax": 0.85,
    "Taxability": true,
    "Taxable": 3.99,
    "TaxDetails": [
        {
            "TaxId": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
            "TaxName": "GST",
            "CountryCode": "CA",
            "Rate": 15,
            "RegionCode": "AB",
            "Tax": 3.99,
            "Taxable": 3.99,
            "TaxAuthority": "CRA",
            "TaxAuthorityType": "Canada",
            "TaxCategory": "Goods and Sales",
            "TaxType": "Provincial"
        }
    ]
}
Name Description
LineNumber (String) Identifier of the Line Item
Discount (Decimal) Discount
Rate (Decimal) Effective tax rate
Tax (Decimal) Tax to be charged
Taxability (Boolean) A flag to indicate the Item is taxable
Taxable (Decimal) Taxable amount
TaxDetails (Array[TaxDetail]) Tax Details

TaxDetail

{
    "TaxId": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
    "TaxName": "GST",
    "CountryCode": "CA",
    "Rate": 15,
    "RegionCode": "AB",
    "Tax": 3.99,
    "Taxable": 3.99,
    "TaxAuthority": "CRA",
    "TaxAuthorityType": "Canada",
    "TaxCategory": "Goods and Sales",
    "TaxType": "Provincial"
}
Name Description
TaxId (GUID) Unique Identifier
TaxName (String) Tax name
CountryCode (String) Country. Uses the ISO 3166-1 alpha-2 standard. For a list of acceptable codes, see Getting All Countries
Rate (Decimal) Effective tax rate for this tax juristiction
RegionCode (String) Code for the State/Province in which this address resides. Based off the ISO 3166-2 standard. For a list of acceptable codes, see Getting All Countries
Tax (Decimal) Taxable amount for tax juristiction
Taxable (Decimal) Taxable amount on the line
TaxAuthority (String) Tax Authority
TaxAuthorityType (String) Description of Tax Authority
TaxCategory (String) Category for the Tax
TaxType (String) Description of the Tax

Payment

{
    "Id": "15215",
    "Amount": 15,
    "DrawerId": "f41b20b2-31cb-4585-aca2-e17b1b1de41e",
    "PaymentMethodId": 4,
    "ReferenceId": "Pay5531",
    "TransactionDate": "2016-01-06T16:22:41.1236641+00:00",
    "TransactionType": "Purchase"
}
Name Description
Id (String) Identifier for the Payment
Amount (Decimal) Transaction amount
DrawerId (GUID) Identifier for the Drawer the Payment affects
PaymentMethodId (Integer) Identifier for the Payment Method
ReferenceId (String) Identifier for the Payment in an external system
TransactionDate (DateTime) Date the transaction occured
TransactionType (String) See PaymentTransactionType

Enumerations

PaymentTransactionType

Id Value
1 Purchase
0 Refund

REQUESTS

GET Invoice Summaries for a Company

The sorting order of the response will be descending order by CreatedDateUtc with the most recent invoices listed first.

See Filtering to learn more about filtering resources.

Request

GET /Companies({CompanyId})/InvoiceSummaries?$filter=CustomerId eq guid'{CustomerId}' and LocationId eq {LocationId} and EmployeeId eq {EmployeeId}

Example Request

GET /Companies(14146)/InvoiceSummaries?$filter=CustomerId eq guid'503d1d4a-c974-4286-b4a2-002699e60ad6' and LocationId eq 4 and EmployeeId eq 15
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://invoicedemo.iqmetrix.net/v1/Companies(14146)/InvoiceSummaries?$filter=CustomerId eq guid'503d1d4a-c974-4286-b4a2-002699e60ad6' and LocationId eq 4 and EmployeeId eq 15" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingInvoiceSummariesForACompany()
{
    var client = new RestClient("https://invoicedemo.iqmetrix.net/v1/Companies(14146)/InvoiceSummaries?$filter=CustomerId eq guid'503d1d4a-c974-4286-b4a2-002699e60ad6' and LocationId eq 4 and EmployeeId eq 15");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingInvoiceSummariesForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://invoicedemo.iqmetrix.net/v1/Companies(14146)/InvoiceSummaries?$filter=CustomerId eq guid'503d1d4a-c974-4286-b4a2-002699e60ad6' and LocationId eq 4 and EmployeeId eq 15");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://invoicedemo.iqmetrix.net/v1/Companies(14146)/InvoiceSummaries?$filter=CustomerId eq guid'503d1d4a-c974-4286-b4a2-002699e60ad6' and LocationId eq 4 and EmployeeId eq 15', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "418938fe-e3e2-4f66-af01-a485a02a6b09",
        "CreatedDateUtc": "2016-01-18T15:56:23.2526213Z",
        "CustomerId": "503d1d4a-c974-4286-b4a2-002699e60ad6",
        "EmployeeId": 15,
        "InvoiceTotal": 59.99,
        "InvoiceType": "None",
        "LocationId": 4,
        "PrintableId": "8765-1234-987"
    }
]

Array[InvoiceSummary]

GET an Invoice

Request

GET /Companies({CompanyId})/Invoices({InvoiceId})

Example Request

GET /Companies(14146)/Invoices(c21d5c8c-2b06-4ac4-a3f2-0a15c07557f1)
Accept: application/json

curl -X GET "https://invoicedemo.iqmetrix.net/v1/Companies(14146)/Invoices(c21d5c8c-2b06-4ac4-a3f2-0a15c07557f1)" -H "Accept: application/json"
static IRestResponse GettingAnInvoice()
{
    var client = new RestClient("https://invoicedemo.iqmetrix.net/v1/Companies(14146)/Invoices(c21d5c8c-2b06-4ac4-a3f2-0a15c07557f1)");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Accept", "application/json"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingAnInvoice() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://invoicedemo.iqmetrix.net/v1/Companies(14146)/Invoices(c21d5c8c-2b06-4ac4-a3f2-0a15c07557f1)");
     
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://invoicedemo.iqmetrix.net/v1/Companies(14146)/Invoices(c21d5c8c-2b06-4ac4-a3f2-0a15c07557f1)', {
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "418938fe-e3e2-4f66-af01-a485a02a6b09",
    "CreatedByUser": "22212",
    "CreatedDateUtc": "2015-04-23T13:14:12.997",
    "Customer": {
        "Id": "503d1d4a-c974-4286-b4a2-002699e60ad6",
        "AlternateName": "Bob",
        "BillingAddress": {
            "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
            "CountryCode": "CA",
            "DoNotContact": false,
            "Locality": "Mountain View",
            "Notes": "New residence",
            "PostalCode": "94043",
            "PostOfficeBoxNumber": "P.O. Box 1022",
            "StateCode": "AB",
            "StreetAddress1": "1600 Amphitheatre Pkwy",
            "StreetAddress2": "Suite 500"
        },
        "CustomerType": "Person",
        "CustomerTypeId": 2,
        "DateOfBirth": "1952-07-23T12:00:00.000",
        "DoNotContact": false,
        "FamilyName": "Smith",
        "MiddleName": "Lee",
        "Notes": "Interested in iPhone 6",
        "PrimaryName": "Robert",
        "ShippingAddress": {
            "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
            "CountryCode": "CA",
            "DoNotContact": false,
            "Locality": "Mountain View",
            "Notes": "New residence",
            "PostalCode": "94043",
            "PostOfficeBoxNumber": "P.O. Box 1022",
            "StateCode": "AB",
            "StreetAddress1": "1600 Amphitheatre Pkwy",
            "StreetAddress2": "Suite 500"
        },
        "Title": "Mr"
    },
    "DropshipOrders": [
        {
            "Id": "216f7424-ae18-4c69-9597-984b430d0759",
            "Items": [
                {
                    "Id": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
                    "Description": "iPhone 4s",
                    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
                    "Quantity": 1,
                    "SellingPrice": 499,
                    "Sku": "403405"
                }
            ],
            "PrintableId": "8765-1234-987",
            "ReferenceId": "INV112",
            "ShippingEntityId": 4,
            "ShippingMethod": "350",
            "SupplierId": 14107
        }
    ],
    "EmployeeId": 15,
    "IsRefund": false,
    "LocationId": 4,
    "Notes": "Trade in iPhone",
    "Orders": [
        {
            "Id": "216f7424-ae18-4c69-9597-984b430d0759",
            "Items": [
                {
                    "Id": "0fff7fb5-4620-4b81-8199-ec41ba6f0451",
                    "Description": "iPhone 4s",
                    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
                    "Quantity": 1,
                    "SellingPrice": 499,
                    "SerialNumber": "B7FQ-RANC",
                    "Sku": "403405"
                }
            ],
            "PrintableId": "8765-1234-987",
            "ReferenceId": "INV112"
        }
    ],
    "OriginalInvoiceId": "7832c7e8-6b3e-4538-9414-e3ca68058d9f",
    "Payments": [
        {
            "Id": "15215",
            "Amount": 15,
            "DrawerId": "f41b20b2-31cb-4585-aca2-e17b1b1de41e",
            "PaymentMethodId": 4,
            "ReferenceId": "Pay5531",
            "TransactionDate": "2016-01-06T16:22:41.1236641+00:00",
            "TransactionType": "Purchase"
        }
    ],
    "PrintableId": "8765-1234-987",
    "TaxCalculationResult": {
        "Id": "da7409e3-060d-4c98-b3bd-b0cb7a0efa0d",
        "Lines": [
            {
                "LineNumber": "Line1",
                "Discount": 0.51,
                "Rate": 15,
                "Tax": 0.85,
                "Taxability": true,
                "Taxable": 3.99,
                "TaxDetails": [
                    {
                        "TaxId": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
                        "TaxName": "GST",
                        "CountryCode": "CA",
                        "Rate": 15,
                        "RegionCode": "AB",
                        "Tax": 3.99,
                        "Taxable": 3.99,
                        "TaxAuthority": "CRA",
                        "TaxAuthorityType": "Canada",
                        "TaxCategory": "Goods and Sales",
                        "TaxType": "Provincial"
                    }
                ]
            }
        ]
    }
}

Invoice

POST an Invoice

Request

POST /Companies({CompanyId})/Invoices

Example Request

POST /Companies(14146)/Invoices
Authorization: Bearer (Access Token)
Accept: application/json
Content-Type: application/json

{
    "Customer": {
        "Id": "503d1d4a-c974-4286-b4a2-002699e60ad6",
        "AlternateName": "Bob",
        "BillingAddress": {
            "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
            "CountryCode": "CA",
            "DoNotContact": false,
            "Locality": "Mountain View",
            "Notes": "New residence",
            "PostalCode": "94043",
            "PostOfficeBoxNumber": "P.O. Box 1022",
            "StateCode": "AB",
            "StreetAddress1": "1600 Amphitheatre Pkwy",
            "StreetAddress2": "Suite 500"
        },
        "CustomerType": "Person",
        "CustomerTypeId": 2,
        "DateOfBirth": "1952-07-23T12:00:00.000",
        "DoNotContact": false,
        "FamilyName": "Smith",
        "MiddleName": "Lee",
        "Notes": "Interested in iPhone 6",
        "PrimaryName": "Robert",
        "ShippingAddress": {
            "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
            "CountryCode": "CA",
            "DoNotContact": false,
            "Locality": "Mountain View",
            "Notes": "New residence",
            "PostalCode": "94043",
            "PostOfficeBoxNumber": "P.O. Box 1022",
            "StateCode": "AB",
            "StreetAddress1": "1600 Amphitheatre Pkwy",
            "StreetAddress2": "Suite 500"
        },
        "Title": "Mr"
    },
    "DropshipOrders": [
        {
            "Id": "216f7424-ae18-4c69-9597-984b430d0759",
            "Items": [
                {
                    "Id": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
                    "Description": "iPhone 4s",
                    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
                    "Quantity": 1,
                    "SellingPrice": 499,
                    "Sku": "403405"
                }
            ],
            "PrintableId": "8765-1234-987",
            "ReferenceId": "INV112",
            "ShippingEntityId": 4,
            "ShippingMethod": "350",
            "SupplierId": 14107
        }
    ],
    "EmployeeId": 15,
    "IsRefund": false,
    "LocationId": 4,
    "Notes": "Trade in iPhone",
    "Orders": [
        {
            "Id": "216f7424-ae18-4c69-9597-984b430d0759",
            "Items": [
                {
                    "Id": "0fff7fb5-4620-4b81-8199-ec41ba6f0451",
                    "Description": "iPhone 4s",
                    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
                    "Quantity": 1,
                    "SellingPrice": 499,
                    "SerialNumber": "B7FQ-RANC",
                    "Sku": "403405"
                }
            ],
            "PrintableId": "8765-1234-987",
            "ReferenceId": "INV112"
        }
    ],
    "OriginalInvoiceId": "7832c7e8-6b3e-4538-9414-e3ca68058d9f",
    "Payments": [
        {
            "Id": "15215",
            "Amount": 15,
            "DrawerId": "f41b20b2-31cb-4585-aca2-e17b1b1de41e",
            "PaymentMethodId": 4,
            "ReferenceId": "Pay5531",
            "TransactionDate": "2016-01-06T16:22:41.1236641+00:00",
            "TransactionType": "Purchase"
        }
    ],
    "PrintableId": "8765-1234-987",
    "TaxCalculationResult": {
        "Id": "da7409e3-060d-4c98-b3bd-b0cb7a0efa0d",
        "Lines": [
            {
                "LineNumber": "Line1",
                "Discount": 0.51,
                "Rate": 15,
                "Tax": 0.85,
                "Taxability": true,
                "Taxable": 3.99,
                "TaxDetails": [
                    {
                        "TaxId": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
                        "TaxName": "GST",
                        "CountryCode": "CA",
                        "Rate": 15,
                        "RegionCode": "AB",
                        "Tax": 3.99,
                        "Taxable": 3.99,
                        "TaxAuthority": "CRA",
                        "TaxAuthorityType": "Canada",
                        "TaxCategory": "Goods and Sales",
                        "TaxType": "Provincial"
                    }
                ]
            }
        ]
    }
}
curl -X POST "https://invoicedemo.iqmetrix.net/v1/Companies(14146)/Invoices" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json" -H "Content-Type: application/json" -d '{
    "Customer": {
        "Id": "503d1d4a-c974-4286-b4a2-002699e60ad6",
        "AlternateName": "Bob",
        "BillingAddress": {
            "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
            "CountryCode": "CA",
            "DoNotContact": false,
            "Locality": "Mountain View",
            "Notes": "New residence",
            "PostalCode": "94043",
            "PostOfficeBoxNumber": "P.O. Box 1022",
            "StateCode": "AB",
            "StreetAddress1": "1600 Amphitheatre Pkwy",
            "StreetAddress2": "Suite 500"
        },
        "CustomerType": "Person",
        "CustomerTypeId": 2,
        "DateOfBirth": "1952-07-23T12:00:00.000",
        "DoNotContact": false,
        "FamilyName": "Smith",
        "MiddleName": "Lee",
        "Notes": "Interested in iPhone 6",
        "PrimaryName": "Robert",
        "ShippingAddress": {
            "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
            "CountryCode": "CA",
            "DoNotContact": false,
            "Locality": "Mountain View",
            "Notes": "New residence",
            "PostalCode": "94043",
            "PostOfficeBoxNumber": "P.O. Box 1022",
            "StateCode": "AB",
            "StreetAddress1": "1600 Amphitheatre Pkwy",
            "StreetAddress2": "Suite 500"
        },
        "Title": "Mr"
    },
    "DropshipOrders": [
        {
            "Id": "216f7424-ae18-4c69-9597-984b430d0759",
            "Items": [
                {
                    "Id": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
                    "Description": "iPhone 4s",
                    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
                    "Quantity": 1,
                    "SellingPrice": 499,
                    "Sku": "403405"
                }
            ],
            "PrintableId": "8765-1234-987",
            "ReferenceId": "INV112",
            "ShippingEntityId": 4,
            "ShippingMethod": "350",
            "SupplierId": 14107
        }
    ],
    "EmployeeId": 15,
    "IsRefund": false,
    "LocationId": 4,
    "Notes": "Trade in iPhone",
    "Orders": [
        {
            "Id": "216f7424-ae18-4c69-9597-984b430d0759",
            "Items": [
                {
                    "Id": "0fff7fb5-4620-4b81-8199-ec41ba6f0451",
                    "Description": "iPhone 4s",
                    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
                    "Quantity": 1,
                    "SellingPrice": 499,
                    "SerialNumber": "B7FQ-RANC",
                    "Sku": "403405"
                }
            ],
            "PrintableId": "8765-1234-987",
            "ReferenceId": "INV112"
        }
    ],
    "OriginalInvoiceId": "7832c7e8-6b3e-4538-9414-e3ca68058d9f",
    "Payments": [
        {
            "Id": "15215",
            "Amount": 15,
            "DrawerId": "f41b20b2-31cb-4585-aca2-e17b1b1de41e",
            "PaymentMethodId": 4,
            "ReferenceId": "Pay5531",
            "TransactionDate": "2016-01-06T16:22:41.1236641+00:00",
            "TransactionType": "Purchase"
        }
    ],
    "PrintableId": "8765-1234-987",
    "TaxCalculationResult": {
        "Id": "da7409e3-060d-4c98-b3bd-b0cb7a0efa0d",
        "Lines": [
            {
                "LineNumber": "Line1",
                "Discount": 0.51,
                "Rate": 15,
                "Tax": 0.85,
                "Taxability": true,
                "Taxable": 3.99,
                "TaxDetails": [
                    {
                        "TaxId": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
                        "TaxName": "GST",
                        "CountryCode": "CA",
                        "Rate": 15,
                        "RegionCode": "AB",
                        "Tax": 3.99,
                        "Taxable": 3.99,
                        "TaxAuthority": "CRA",
                        "TaxAuthorityType": "Canada",
                        "TaxCategory": "Goods and Sales",
                        "TaxType": "Provincial"
                    }
                ]
            }
        ]
    }
}'
static IRestResponse CreatingAnInvoice()
{
    var client = new RestClient("https://invoicedemo.iqmetrix.net/v1/Companies(14146)/Invoices");
    var request = new RestRequest(Method.POST);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 
    request.AddHeader("Content-Type", "application/json"); 

     request.AddParameter("application/json", "{\"Customer\":{\"Id\":\"503d1d4a-c974-4286-b4a2-002699e60ad6\",\"AlternateName\":\"Bob\",\"BillingAddress\":{\"Id\":\"e68a5c8c-eadc-484c-9139-8437d2e0859a\",\"CountryCode\":\"CA\",\"DoNotContact\":false,\"Locality\":\"Mountain View\",\"Notes\":\"New residence\",\"PostalCode\":\"94043\",\"PostOfficeBoxNumber\":\"P.O. Box 1022\",\"StateCode\":\"AB\",\"StreetAddress1\":\"1600 Amphitheatre Pkwy\",\"StreetAddress2\":\"Suite 500\"},\"CustomerType\":\"Person\",\"CustomerTypeId\":2,\"DateOfBirth\":\"1952-07-23T12:00:00.000\",\"DoNotContact\":false,\"FamilyName\":\"Smith\",\"MiddleName\":\"Lee\",\"Notes\":\"Interested in iPhone 6\",\"PrimaryName\":\"Robert\",\"ShippingAddress\":{\"Id\":\"e68a5c8c-eadc-484c-9139-8437d2e0859a\",\"CountryCode\":\"CA\",\"DoNotContact\":false,\"Locality\":\"Mountain View\",\"Notes\":\"New residence\",\"PostalCode\":\"94043\",\"PostOfficeBoxNumber\":\"P.O. Box 1022\",\"StateCode\":\"AB\",\"StreetAddress1\":\"1600 Amphitheatre Pkwy\",\"StreetAddress2\":\"Suite 500\"},\"Title\":\"Mr\"},\"DropshipOrders\":[{\"Id\":\"216f7424-ae18-4c69-9597-984b430d0759\",\"Items\":[{\"Id\":\"a08f1363-514f-4268-8e4c-cddd3ab347d8\",\"Description\":\"iPhone 4s\",\"ProductId\":\"a183f1a9-c58f-426a-930a-9a6357db52ed\",\"Quantity\":1,\"SellingPrice\":499,\"Sku\":\"403405\"}],\"PrintableId\":\"8765-1234-987\",\"ReferenceId\":\"INV112\",\"ShippingEntityId\":4,\"ShippingMethod\":\"350\",\"SupplierId\":14107}],\"EmployeeId\":15,\"IsRefund\":false,\"LocationId\":4,\"Notes\":\"Trade in iPhone\",\"Orders\":[{\"Id\":\"216f7424-ae18-4c69-9597-984b430d0759\",\"Items\":[{\"Id\":\"0fff7fb5-4620-4b81-8199-ec41ba6f0451\",\"Description\":\"iPhone 4s\",\"ProductId\":\"a183f1a9-c58f-426a-930a-9a6357db52ed\",\"Quantity\":1,\"SellingPrice\":499,\"SerialNumber\":\"B7FQ-RANC\",\"Sku\":\"403405\"}],\"PrintableId\":\"8765-1234-987\",\"ReferenceId\":\"INV112\"}],\"OriginalInvoiceId\":\"7832c7e8-6b3e-4538-9414-e3ca68058d9f\",\"Payments\":[{\"Id\":\"15215\",\"Amount\":15,\"DrawerId\":\"f41b20b2-31cb-4585-aca2-e17b1b1de41e\",\"PaymentMethodId\":4,\"ReferenceId\":\"Pay5531\",\"TransactionDate\":\"2016-01-06T16:22:41.1236641+00:00\",\"TransactionType\":\"Purchase\"}],\"PrintableId\":\"8765-1234-987\",\"TaxCalculationResult\":{\"Id\":\"da7409e3-060d-4c98-b3bd-b0cb7a0efa0d\",\"Lines\":[{\"LineNumber\":\"Line1\",\"Discount\":0.51,\"Rate\":15,\"Tax\":0.85,\"Taxability\":true,\"Taxable\":3.99,\"TaxDetails\":[{\"TaxId\":\"a08f1363-514f-4268-8e4c-cddd3ab347d8\",\"TaxName\":\"GST\",\"CountryCode\":\"CA\",\"Rate\":15,\"RegionCode\":\"AB\",\"Tax\":3.99,\"Taxable\":3.99,\"TaxAuthority\":\"CRA\",\"TaxAuthorityType\":\"Canada\",\"TaxCategory\":\"Goods and Sales\",\"TaxType\":\"Provincial\"}]}]}}", ParameterType.RequestBody);

    return client.Execute(request);
}
import org.apache.http.entity.StringEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse CreatingAnInvoice() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://invoicedemo.iqmetrix.net/v1/Companies(14146)/Invoices");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    request.addHeader("Content-Type", "application/json"); 
    StringEntity body = new StringEntity("{\"Customer\":{\"Id\":\"503d1d4a-c974-4286-b4a2-002699e60ad6\",\"AlternateName\":\"Bob\",\"BillingAddress\":{\"Id\":\"e68a5c8c-eadc-484c-9139-8437d2e0859a\",\"CountryCode\":\"CA\",\"DoNotContact\":false,\"Locality\":\"Mountain View\",\"Notes\":\"New residence\",\"PostalCode\":\"94043\",\"PostOfficeBoxNumber\":\"P.O. Box 1022\",\"StateCode\":\"AB\",\"StreetAddress1\":\"1600 Amphitheatre Pkwy\",\"StreetAddress2\":\"Suite 500\"},\"CustomerType\":\"Person\",\"CustomerTypeId\":2,\"DateOfBirth\":\"1952-07-23T12:00:00.000\",\"DoNotContact\":false,\"FamilyName\":\"Smith\",\"MiddleName\":\"Lee\",\"Notes\":\"Interested in iPhone 6\",\"PrimaryName\":\"Robert\",\"ShippingAddress\":{\"Id\":\"e68a5c8c-eadc-484c-9139-8437d2e0859a\",\"CountryCode\":\"CA\",\"DoNotContact\":false,\"Locality\":\"Mountain View\",\"Notes\":\"New residence\",\"PostalCode\":\"94043\",\"PostOfficeBoxNumber\":\"P.O. Box 1022\",\"StateCode\":\"AB\",\"StreetAddress1\":\"1600 Amphitheatre Pkwy\",\"StreetAddress2\":\"Suite 500\"},\"Title\":\"Mr\"},\"DropshipOrders\":[{\"Id\":\"216f7424-ae18-4c69-9597-984b430d0759\",\"Items\":[{\"Id\":\"a08f1363-514f-4268-8e4c-cddd3ab347d8\",\"Description\":\"iPhone 4s\",\"ProductId\":\"a183f1a9-c58f-426a-930a-9a6357db52ed\",\"Quantity\":1,\"SellingPrice\":499,\"Sku\":\"403405\"}],\"PrintableId\":\"8765-1234-987\",\"ReferenceId\":\"INV112\",\"ShippingEntityId\":4,\"ShippingMethod\":\"350\",\"SupplierId\":14107}],\"EmployeeId\":15,\"IsRefund\":false,\"LocationId\":4,\"Notes\":\"Trade in iPhone\",\"Orders\":[{\"Id\":\"216f7424-ae18-4c69-9597-984b430d0759\",\"Items\":[{\"Id\":\"0fff7fb5-4620-4b81-8199-ec41ba6f0451\",\"Description\":\"iPhone 4s\",\"ProductId\":\"a183f1a9-c58f-426a-930a-9a6357db52ed\",\"Quantity\":1,\"SellingPrice\":499,\"SerialNumber\":\"B7FQ-RANC\",\"Sku\":\"403405\"}],\"PrintableId\":\"8765-1234-987\",\"ReferenceId\":\"INV112\"}],\"OriginalInvoiceId\":\"7832c7e8-6b3e-4538-9414-e3ca68058d9f\",\"Payments\":[{\"Id\":\"15215\",\"Amount\":15,\"DrawerId\":\"f41b20b2-31cb-4585-aca2-e17b1b1de41e\",\"PaymentMethodId\":4,\"ReferenceId\":\"Pay5531\",\"TransactionDate\":\"2016-01-06T16:22:41.1236641+00:00\",\"TransactionType\":\"Purchase\"}],\"PrintableId\":\"8765-1234-987\",\"TaxCalculationResult\":{\"Id\":\"da7409e3-060d-4c98-b3bd-b0cb7a0efa0d\",\"Lines\":[{\"LineNumber\":\"Line1\",\"Discount\":0.51,\"Rate\":15,\"Tax\":0.85,\"Taxability\":true,\"Taxable\":3.99,\"TaxDetails\":[{\"TaxId\":\"a08f1363-514f-4268-8e4c-cddd3ab347d8\",\"TaxName\":\"GST\",\"CountryCode\":\"CA\",\"Rate\":15,\"RegionCode\":\"AB\",\"Tax\":3.99,\"Taxable\":3.99,\"TaxAuthority\":\"CRA\",\"TaxAuthorityType\":\"Canada\",\"TaxCategory\":\"Goods and Sales\",\"TaxType\":\"Provincial\"}]}]}}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"Customer\":{\"Id\":\"503d1d4a-c974-4286-b4a2-002699e60ad6\",\"AlternateName\":\"Bob\",\"BillingAddress\":{\"Id\":\"e68a5c8c-eadc-484c-9139-8437d2e0859a\",\"CountryCode\":\"CA\",\"DoNotContact\":false,\"Locality\":\"Mountain View\",\"Notes\":\"New residence\",\"PostalCode\":\"94043\",\"PostOfficeBoxNumber\":\"P.O. Box 1022\",\"StateCode\":\"AB\",\"StreetAddress1\":\"1600 Amphitheatre Pkwy\",\"StreetAddress2\":\"Suite 500\"},\"CustomerType\":\"Person\",\"CustomerTypeId\":2,\"DateOfBirth\":\"1952-07-23T12:00:00.000\",\"DoNotContact\":false,\"FamilyName\":\"Smith\",\"MiddleName\":\"Lee\",\"Notes\":\"Interested in iPhone 6\",\"PrimaryName\":\"Robert\",\"ShippingAddress\":{\"Id\":\"e68a5c8c-eadc-484c-9139-8437d2e0859a\",\"CountryCode\":\"CA\",\"DoNotContact\":false,\"Locality\":\"Mountain View\",\"Notes\":\"New residence\",\"PostalCode\":\"94043\",\"PostOfficeBoxNumber\":\"P.O. Box 1022\",\"StateCode\":\"AB\",\"StreetAddress1\":\"1600 Amphitheatre Pkwy\",\"StreetAddress2\":\"Suite 500\"},\"Title\":\"Mr\"},\"DropshipOrders\":[{\"Id\":\"216f7424-ae18-4c69-9597-984b430d0759\",\"Items\":[{\"Id\":\"a08f1363-514f-4268-8e4c-cddd3ab347d8\",\"Description\":\"iPhone 4s\",\"ProductId\":\"a183f1a9-c58f-426a-930a-9a6357db52ed\",\"Quantity\":1,\"SellingPrice\":499,\"Sku\":\"403405\"}],\"PrintableId\":\"8765-1234-987\",\"ReferenceId\":\"INV112\",\"ShippingEntityId\":4,\"ShippingMethod\":\"350\",\"SupplierId\":14107}],\"EmployeeId\":15,\"IsRefund\":false,\"LocationId\":4,\"Notes\":\"Trade in iPhone\",\"Orders\":[{\"Id\":\"216f7424-ae18-4c69-9597-984b430d0759\",\"Items\":[{\"Id\":\"0fff7fb5-4620-4b81-8199-ec41ba6f0451\",\"Description\":\"iPhone 4s\",\"ProductId\":\"a183f1a9-c58f-426a-930a-9a6357db52ed\",\"Quantity\":1,\"SellingPrice\":499,\"SerialNumber\":\"B7FQ-RANC\",\"Sku\":\"403405\"}],\"PrintableId\":\"8765-1234-987\",\"ReferenceId\":\"INV112\"}],\"OriginalInvoiceId\":\"7832c7e8-6b3e-4538-9414-e3ca68058d9f\",\"Payments\":[{\"Id\":\"15215\",\"Amount\":15,\"DrawerId\":\"f41b20b2-31cb-4585-aca2-e17b1b1de41e\",\"PaymentMethodId\":4,\"ReferenceId\":\"Pay5531\",\"TransactionDate\":\"2016-01-06T16:22:41.1236641+00:00\",\"TransactionType\":\"Purchase\"}],\"PrintableId\":\"8765-1234-987\",\"TaxCalculationResult\":{\"Id\":\"da7409e3-060d-4c98-b3bd-b0cb7a0efa0d\",\"Lines\":[{\"LineNumber\":\"Line1\",\"Discount\":0.51,\"Rate\":15,\"Tax\":0.85,\"Taxability\":true,\"Taxable\":3.99,\"TaxDetails\":[{\"TaxId\":\"a08f1363-514f-4268-8e4c-cddd3ab347d8\",\"TaxName\":\"GST\",\"CountryCode\":\"CA\",\"Rate\":15,\"RegionCode\":\"AB\",\"Tax\":3.99,\"Taxable\":3.99,\"TaxAuthority\":\"CRA\",\"TaxAuthorityType\":\"Canada\",\"TaxCategory\":\"Goods and Sales\",\"TaxType\":\"Provincial\"}]}]}}";

response = RestClient.post 'https://invoicedemo.iqmetrix.net/v1/Companies(14146)/Invoices', body, {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
     :'Content-Type' => 'application/json',
    } 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 201 Content-Type: application/json
{
    "Id": "418938fe-e3e2-4f66-af01-a485a02a6b09",
    "CreatedByUser": "22212",
    "CreatedDateUtc": "2015-04-23T13:14:12.997",
    "Customer": {
        "Id": "503d1d4a-c974-4286-b4a2-002699e60ad6",
        "AlternateName": "Bob",
        "BillingAddress": {
            "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
            "CountryCode": "CA",
            "DoNotContact": false,
            "Locality": "Mountain View",
            "Notes": "New residence",
            "PostalCode": "94043",
            "PostOfficeBoxNumber": "P.O. Box 1022",
            "StateCode": "AB",
            "StreetAddress1": "1600 Amphitheatre Pkwy",
            "StreetAddress2": "Suite 500"
        },
        "CustomerType": "Person",
        "CustomerTypeId": 2,
        "DateOfBirth": "1952-07-23T12:00:00.000",
        "DoNotContact": false,
        "FamilyName": "Smith",
        "MiddleName": "Lee",
        "Notes": "Interested in iPhone 6",
        "PrimaryName": "Robert",
        "ShippingAddress": {
            "Id": "e68a5c8c-eadc-484c-9139-8437d2e0859a",
            "CountryCode": "CA",
            "DoNotContact": false,
            "Locality": "Mountain View",
            "Notes": "New residence",
            "PostalCode": "94043",
            "PostOfficeBoxNumber": "P.O. Box 1022",
            "StateCode": "AB",
            "StreetAddress1": "1600 Amphitheatre Pkwy",
            "StreetAddress2": "Suite 500"
        },
        "Title": "Mr"
    },
    "DropshipOrders": [
        {
            "Id": "216f7424-ae18-4c69-9597-984b430d0759",
            "Items": [
                {
                    "Id": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
                    "Description": "iPhone 4s",
                    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
                    "Quantity": 1,
                    "SellingPrice": 499,
                    "Sku": "403405"
                }
            ],
            "PrintableId": "8765-1234-987",
            "ReferenceId": "INV112",
            "ShippingEntityId": 4,
            "ShippingMethod": "350",
            "SupplierId": 14107
        }
    ],
    "EmployeeId": 15,
    "IsRefund": false,
    "LocationId": 4,
    "Notes": "Trade in iPhone",
    "Orders": [
        {
            "Id": "216f7424-ae18-4c69-9597-984b430d0759",
            "Items": [
                {
                    "Id": "0fff7fb5-4620-4b81-8199-ec41ba6f0451",
                    "Description": "iPhone 4s",
                    "ProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
                    "Quantity": 1,
                    "SellingPrice": 499,
                    "SerialNumber": "B7FQ-RANC",
                    "Sku": "403405"
                }
            ],
            "PrintableId": "8765-1234-987",
            "ReferenceId": "INV112"
        }
    ],
    "OriginalInvoiceId": "7832c7e8-6b3e-4538-9414-e3ca68058d9f",
    "Payments": [
        {
            "Id": "15215",
            "Amount": 15,
            "DrawerId": "f41b20b2-31cb-4585-aca2-e17b1b1de41e",
            "PaymentMethodId": 4,
            "ReferenceId": "Pay5531",
            "TransactionDate": "2016-01-06T16:22:41.1236641+00:00",
            "TransactionType": "Purchase"
        }
    ],
    "PrintableId": "8765-1234-987",
    "TaxCalculationResult": {
        "Id": "da7409e3-060d-4c98-b3bd-b0cb7a0efa0d",
        "Lines": [
            {
                "LineNumber": "Line1",
                "Discount": 0.51,
                "Rate": 15,
                "Tax": 0.85,
                "Taxability": true,
                "Taxable": 3.99,
                "TaxDetails": [
                    {
                        "TaxId": "a08f1363-514f-4268-8e4c-cddd3ab347d8",
                        "TaxName": "GST",
                        "CountryCode": "CA",
                        "Rate": 15,
                        "RegionCode": "AB",
                        "Tax": 3.99,
                        "Taxable": 3.99,
                        "TaxAuthority": "CRA",
                        "TaxAuthorityType": "Canada",
                        "TaxCategory": "Goods and Sales",
                        "TaxType": "Provincial"
                    }
                ]
            }
        ]
    }
}

Invoice

Was this page helpful?