POST api/v1/Invoice
Return a list of all invoices and credits for a specific customer or all customers,
raised between 2 specified dates.
Request Information
URI Parameters
None.
Body Parameters
InvoiceParams| Name | Description | Type | Additional information |
|---|---|---|---|
| apiKey |
Please contact Caliq support to get your key |
string |
Required |
| DateFrom |
List invoices created on and since YYYYMMDD. If supplied empty then all invoices will be returned |
string |
None. |
| DateTo |
List invoices created on and before YYYYMMDD. If supplied empty then all invoices will be returned |
string |
None. |
| AccountNo |
Customer account number to return invoices for |
string |
None. |
| CustomerID |
Customer ID to return invoices for |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"DateFrom": "sample string 1",
"DateTo": "sample string 2",
"AccountNo": "sample string 3",
"CustomerID": 4,
"apiKey": "sample string 1"
}
application/xml, text/xml
Sample:
<InvoiceParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <DateFrom>sample string 1</DateFrom> <DateTo>sample string 2</DateTo> <AccountNo>sample string 3</AccountNo> <CustomerID>4</CustomerID> <apiKey>sample string 1</apiKey> </InvoiceParams>
Response Information
Resource Description
Returns:
200 OK Returns error list if failed
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable
| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceList | Collection of InvoiceHeader |
None. |
Response Formats
application/json, text/json
Sample:
{
"InvoiceList": [
{
"Kind": "sample string 1",
"InvoiceNo": "sample string 2",
"TaxPoint": "sample string 3",
"DateCreated": "sample string 4",
"OrderID": 5,
"ShipmentNo": 6,
"WasConsolidated": true,
"OrderNo": 8,
"CustOrderNo": "sample string 9",
"AccountNo": "sample string 10",
"OrderDesc": "sample string 11",
"ChannelName": "sample string 12",
"CustomerVATNo": "sample string 13",
"ContactName": "sample string 14",
"OrderAddress": "sample string 15",
"DeliverAddress": "sample string 16",
"BillingToName": "sample string 17",
"BillingAddress": "sample string 18",
"DespatchNo": "sample string 19",
"CarrierRef": "sample string 20",
"InternalRep": "sample string 21",
"ExternalRep": "sample string 22",
"AccManager": "sample string 23",
"Currency": "sample string 24",
"GoodsSD": 25.0,
"GoodsVATSD": 26.0,
"CarriageSD": 27.0,
"CarriageVATSD": 28.0,
"GoodsMBC": 29.0,
"GoodsVATMBC": 30.0,
"CarriageMBC": 31.0,
"CarriageVATMBC": 32.0,
"GoodsCostMBC": 33.0,
"SurchargeTotalSD": 34.0,
"SurchargeTotalMBC": 35.0,
"DocumentID": 36,
"InvoiceLines": {
"InvoiceLineList": [
{
"ProductID": 1,
"ProductCode": "sample string 2",
"ProductDescription": "sample string 3",
"LineID": 4,
"UOM": "sample string 5",
"CustLineRef": "sample string 6",
"Qty": 7,
"UnitPriceSD": 8.0,
"LinePriceSD": 9.0,
"LineVATSD": 10.0,
"UnitPriceMBC": 11.0,
"LinePriceMBC": 12.0,
"LineVATMBC": 13.0,
"LineCostMBC": 14.0,
"SurchargeSD": 15.0,
"SurchargeMBC": 16.0,
"SurchargePerc": 17.0,
"PricesPer": 18
},
{
"ProductID": 1,
"ProductCode": "sample string 2",
"ProductDescription": "sample string 3",
"LineID": 4,
"UOM": "sample string 5",
"CustLineRef": "sample string 6",
"Qty": 7,
"UnitPriceSD": 8.0,
"LinePriceSD": 9.0,
"LineVATSD": 10.0,
"UnitPriceMBC": 11.0,
"LinePriceMBC": 12.0,
"LineVATMBC": 13.0,
"LineCostMBC": 14.0,
"SurchargeSD": 15.0,
"SurchargeMBC": 16.0,
"SurchargePerc": 17.0,
"PricesPer": 18
}
]
}
},
{
"Kind": "sample string 1",
"InvoiceNo": "sample string 2",
"TaxPoint": "sample string 3",
"DateCreated": "sample string 4",
"OrderID": 5,
"ShipmentNo": 6,
"WasConsolidated": true,
"OrderNo": 8,
"CustOrderNo": "sample string 9",
"AccountNo": "sample string 10",
"OrderDesc": "sample string 11",
"ChannelName": "sample string 12",
"CustomerVATNo": "sample string 13",
"ContactName": "sample string 14",
"OrderAddress": "sample string 15",
"DeliverAddress": "sample string 16",
"BillingToName": "sample string 17",
"BillingAddress": "sample string 18",
"DespatchNo": "sample string 19",
"CarrierRef": "sample string 20",
"InternalRep": "sample string 21",
"ExternalRep": "sample string 22",
"AccManager": "sample string 23",
"Currency": "sample string 24",
"GoodsSD": 25.0,
"GoodsVATSD": 26.0,
"CarriageSD": 27.0,
"CarriageVATSD": 28.0,
"GoodsMBC": 29.0,
"GoodsVATMBC": 30.0,
"CarriageMBC": 31.0,
"CarriageVATMBC": 32.0,
"GoodsCostMBC": 33.0,
"SurchargeTotalSD": 34.0,
"SurchargeTotalMBC": 35.0,
"DocumentID": 36,
"InvoiceLines": {
"InvoiceLineList": [
{
"ProductID": 1,
"ProductCode": "sample string 2",
"ProductDescription": "sample string 3",
"LineID": 4,
"UOM": "sample string 5",
"CustLineRef": "sample string 6",
"Qty": 7,
"UnitPriceSD": 8.0,
"LinePriceSD": 9.0,
"LineVATSD": 10.0,
"UnitPriceMBC": 11.0,
"LinePriceMBC": 12.0,
"LineVATMBC": 13.0,
"LineCostMBC": 14.0,
"SurchargeSD": 15.0,
"SurchargeMBC": 16.0,
"SurchargePerc": 17.0,
"PricesPer": 18
},
{
"ProductID": 1,
"ProductCode": "sample string 2",
"ProductDescription": "sample string 3",
"LineID": 4,
"UOM": "sample string 5",
"CustLineRef": "sample string 6",
"Qty": 7,
"UnitPriceSD": 8.0,
"LinePriceSD": 9.0,
"LineVATSD": 10.0,
"UnitPriceMBC": 11.0,
"LinePriceMBC": 12.0,
"LineVATMBC": 13.0,
"LineCostMBC": 14.0,
"SurchargeSD": 15.0,
"SurchargeMBC": 16.0,
"SurchargePerc": 17.0,
"PricesPer": 18
}
]
}
}
]
}
application/xml, text/xml
Sample:
<Invoices xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<InvoiceHeader>
<Kind>sample string 1</Kind>
<InvoiceNo>sample string 2</InvoiceNo>
<TaxPoint>sample string 3</TaxPoint>
<DateCreated>sample string 4</DateCreated>
<OrderID>5</OrderID>
<ShipmentNo>6</ShipmentNo>
<WasConsolidated>true</WasConsolidated>
<OrderNo>8</OrderNo>
<CustOrderNo>sample string 9</CustOrderNo>
<AccountNo>sample string 10</AccountNo>
<OrderDesc>sample string 11</OrderDesc>
<ChannelName>sample string 12</ChannelName>
<CustomerVATNo>sample string 13</CustomerVATNo>
<ContactName>sample string 14</ContactName>
<OrderAddress>sample string 15</OrderAddress>
<DeliverAddress>sample string 16</DeliverAddress>
<BillingToName>sample string 17</BillingToName>
<BillingAddress>sample string 18</BillingAddress>
<DespatchNo>sample string 19</DespatchNo>
<CarrierRef>sample string 20</CarrierRef>
<InternalRep>sample string 21</InternalRep>
<ExternalRep>sample string 22</ExternalRep>
<AccManager>sample string 23</AccManager>
<Currency>sample string 24</Currency>
<GoodsSD>25</GoodsSD>
<GoodsVATSD>26</GoodsVATSD>
<CarriageSD>27</CarriageSD>
<CarriageVATSD>28</CarriageVATSD>
<GoodsMBC>29</GoodsMBC>
<GoodsVATMBC>30</GoodsVATMBC>
<CarriageMBC>31</CarriageMBC>
<CarriageVATMBC>32</CarriageVATMBC>
<GoodsCostMBC>33</GoodsCostMBC>
<SurchargeTotalSD>34</SurchargeTotalSD>
<SurchargeTotalMBC>35</SurchargeTotalMBC>
<DocumentID>36</DocumentID>
<InvoiceLines>
<InvoiceLine>
<ProductID>1</ProductID>
<ProductCode>sample string 2</ProductCode>
<ProductDescription>sample string 3</ProductDescription>
<LineID>4</LineID>
<UOM>sample string 5</UOM>
<CustLineRef>sample string 6</CustLineRef>
<Qty>7</Qty>
<UnitPriceSD>8</UnitPriceSD>
<LinePriceSD>9</LinePriceSD>
<LineVATSD>10</LineVATSD>
<UnitPriceMBC>11</UnitPriceMBC>
<LinePriceMBC>12</LinePriceMBC>
<LineVATMBC>13</LineVATMBC>
<LineCostMBC>14</LineCostMBC>
<SurchargeSD>15</SurchargeSD>
<SurchargeMBC>16</SurchargeMBC>
<SurchargePerc>17</SurchargePerc>
<PricesPer>18</PricesPer>
</InvoiceLine>
<InvoiceLine>
<ProductID>1</ProductID>
<ProductCode>sample string 2</ProductCode>
<ProductDescription>sample string 3</ProductDescription>
<LineID>4</LineID>
<UOM>sample string 5</UOM>
<CustLineRef>sample string 6</CustLineRef>
<Qty>7</Qty>
<UnitPriceSD>8</UnitPriceSD>
<LinePriceSD>9</LinePriceSD>
<LineVATSD>10</LineVATSD>
<UnitPriceMBC>11</UnitPriceMBC>
<LinePriceMBC>12</LinePriceMBC>
<LineVATMBC>13</LineVATMBC>
<LineCostMBC>14</LineCostMBC>
<SurchargeSD>15</SurchargeSD>
<SurchargeMBC>16</SurchargeMBC>
<SurchargePerc>17</SurchargePerc>
<PricesPer>18</PricesPer>
</InvoiceLine>
</InvoiceLines>
</InvoiceHeader>
<InvoiceHeader>
<Kind>sample string 1</Kind>
<InvoiceNo>sample string 2</InvoiceNo>
<TaxPoint>sample string 3</TaxPoint>
<DateCreated>sample string 4</DateCreated>
<OrderID>5</OrderID>
<ShipmentNo>6</ShipmentNo>
<WasConsolidated>true</WasConsolidated>
<OrderNo>8</OrderNo>
<CustOrderNo>sample string 9</CustOrderNo>
<AccountNo>sample string 10</AccountNo>
<OrderDesc>sample string 11</OrderDesc>
<ChannelName>sample string 12</ChannelName>
<CustomerVATNo>sample string 13</CustomerVATNo>
<ContactName>sample string 14</ContactName>
<OrderAddress>sample string 15</OrderAddress>
<DeliverAddress>sample string 16</DeliverAddress>
<BillingToName>sample string 17</BillingToName>
<BillingAddress>sample string 18</BillingAddress>
<DespatchNo>sample string 19</DespatchNo>
<CarrierRef>sample string 20</CarrierRef>
<InternalRep>sample string 21</InternalRep>
<ExternalRep>sample string 22</ExternalRep>
<AccManager>sample string 23</AccManager>
<Currency>sample string 24</Currency>
<GoodsSD>25</GoodsSD>
<GoodsVATSD>26</GoodsVATSD>
<CarriageSD>27</CarriageSD>
<CarriageVATSD>28</CarriageVATSD>
<GoodsMBC>29</GoodsMBC>
<GoodsVATMBC>30</GoodsVATMBC>
<CarriageMBC>31</CarriageMBC>
<CarriageVATMBC>32</CarriageVATMBC>
<GoodsCostMBC>33</GoodsCostMBC>
<SurchargeTotalSD>34</SurchargeTotalSD>
<SurchargeTotalMBC>35</SurchargeTotalMBC>
<DocumentID>36</DocumentID>
<InvoiceLines>
<InvoiceLine>
<ProductID>1</ProductID>
<ProductCode>sample string 2</ProductCode>
<ProductDescription>sample string 3</ProductDescription>
<LineID>4</LineID>
<UOM>sample string 5</UOM>
<CustLineRef>sample string 6</CustLineRef>
<Qty>7</Qty>
<UnitPriceSD>8</UnitPriceSD>
<LinePriceSD>9</LinePriceSD>
<LineVATSD>10</LineVATSD>
<UnitPriceMBC>11</UnitPriceMBC>
<LinePriceMBC>12</LinePriceMBC>
<LineVATMBC>13</LineVATMBC>
<LineCostMBC>14</LineCostMBC>
<SurchargeSD>15</SurchargeSD>
<SurchargeMBC>16</SurchargeMBC>
<SurchargePerc>17</SurchargePerc>
<PricesPer>18</PricesPer>
</InvoiceLine>
<InvoiceLine>
<ProductID>1</ProductID>
<ProductCode>sample string 2</ProductCode>
<ProductDescription>sample string 3</ProductDescription>
<LineID>4</LineID>
<UOM>sample string 5</UOM>
<CustLineRef>sample string 6</CustLineRef>
<Qty>7</Qty>
<UnitPriceSD>8</UnitPriceSD>
<LinePriceSD>9</LinePriceSD>
<LineVATSD>10</LineVATSD>
<UnitPriceMBC>11</UnitPriceMBC>
<LinePriceMBC>12</LinePriceMBC>
<LineVATMBC>13</LineVATMBC>
<LineCostMBC>14</LineCostMBC>
<SurchargeSD>15</SurchargeSD>
<SurchargeMBC>16</SurchargeMBC>
<SurchargePerc>17</SurchargePerc>
<PricesPer>18</PricesPer>
</InvoiceLine>
</InvoiceLines>
</InvoiceHeader>
</Invoices>