POST api/v1/SLInvoicesDueToChase

Retrieve details of invoices due for payment, to chase

Request Information

URI Parameters

None.

Body Parameters

SLInvoicesDueToChaseParams
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

string

Required

Max length: 30

Request Formats

application/json, text/json

Sample: 
{
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample: 
<SLInvoicesDueToChaseParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
</SLInvoicesDueToChaseParams>

Response Information

Resource Description

Returns:
200 OK Returns a collection of invoices
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content
503 Service Unavailable

SLInvoicesDueToChase
NameDescriptionTypeAdditional information
SLInvoiceDueToChaseList

Collection of SLInvoiceDueToChase

None.

Response Formats

application/json, text/json

Sample: 
{
  "SLInvoiceDueToChaseList": [
    {
      "ID": 1,
      "InvoiceNumber": "sample string 2",
      "DueDate": "sample string 3",
      "EventNumber": 4,
      "CustomerOrderRef": "sample string 5",
      "Currency": "sample string 6",
      "InvoiceAmount": 7.0,
      "InvoiceAmountPaid": 8.0,
      "InvoiceAmountDue": 9.0,
      "AccountNumber": "sample string 10",
      "AccountName": "sample string 11",
      "FirstName": "sample string 12",
      "Surname": "sample string 13",
      "EmailAddress": "sample string 14",
      "PrintDocumentID": 1
    },
    {
      "ID": 1,
      "InvoiceNumber": "sample string 2",
      "DueDate": "sample string 3",
      "EventNumber": 4,
      "CustomerOrderRef": "sample string 5",
      "Currency": "sample string 6",
      "InvoiceAmount": 7.0,
      "InvoiceAmountPaid": 8.0,
      "InvoiceAmountDue": 9.0,
      "AccountNumber": "sample string 10",
      "AccountName": "sample string 11",
      "FirstName": "sample string 12",
      "Surname": "sample string 13",
      "EmailAddress": "sample string 14",
      "PrintDocumentID": 1
    }
  ]
}

application/xml, text/xml

Sample: 
<SLInvoicesDueToChase xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SLInvoiceDueToChase>
    <ID>1</ID>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <DueDate>sample string 3</DueDate>
    <EventNumber>4</EventNumber>
    <CustomerOrderRef>sample string 5</CustomerOrderRef>
    <Currency>sample string 6</Currency>
    <InvoiceAmount>7</InvoiceAmount>
    <InvoiceAmountPaid>8</InvoiceAmountPaid>
    <InvoiceAmountDue>9</InvoiceAmountDue>
    <AccountNumber>sample string 10</AccountNumber>
    <AccountName>sample string 11</AccountName>
    <FirstName>sample string 12</FirstName>
    <Surname>sample string 13</Surname>
    <EmailAddress>sample string 14</EmailAddress>
    <PrintDocumentID>1</PrintDocumentID>
  </SLInvoiceDueToChase>
  <SLInvoiceDueToChase>
    <ID>1</ID>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <DueDate>sample string 3</DueDate>
    <EventNumber>4</EventNumber>
    <CustomerOrderRef>sample string 5</CustomerOrderRef>
    <Currency>sample string 6</Currency>
    <InvoiceAmount>7</InvoiceAmount>
    <InvoiceAmountPaid>8</InvoiceAmountPaid>
    <InvoiceAmountDue>9</InvoiceAmountDue>
    <AccountNumber>sample string 10</AccountNumber>
    <AccountName>sample string 11</AccountName>
    <FirstName>sample string 12</FirstName>
    <Surname>sample string 13</Surname>
    <EmailAddress>sample string 14</EmailAddress>
    <PrintDocumentID>1</PrintDocumentID>
  </SLInvoiceDueToChase>
</SLInvoicesDueToChase>