MyCSI API - Documentation

GET Invoice/{id}

Method used to fetch a collection of Invoices.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Security token provided via the Authentication method.	globally unique identifier	Required

Body Parameters

Objects used to page through the collection of Invoices, as well as filter the returned objects.

InvoiceFilterModel

Name	Description	Type	Additional information
HasCreateDate	Optional, boolean indicating if the Invoice has a created date value.	boolean	None.
InvoiceNumber	Optional, the identifier of the Invoice.	string	None.
Lease	Optional, the Lease to which the Invoice belongs.	string	None.
LessorCountry	Optional, the Country to which the Invoice's Lease belongs.	string	None.
PageNumber	Optional, the number of the current 'page' of items returned during the API request.	integer	None.
PageSize	Optional, number of items in the 'page' returned during the API request.	integer	None.
Schedule	Optional, the Schedule to which the Invoice belongs.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "InvoiceNumber": "sample string 1",
  "LessorCountry": "sample string 2",
  "Lease": "sample string 3",
  "Schedule": "sample string 4",
  "HasCreateDate": true,
  "PageNumber": 1,
  "PageSize": 1
}

application/octet-stream

Sample:

{"InvoiceNumber":"sample string 1","LessorCountry":"sample string 2","Lease":"sample string 3","Schedule":"sample string 4","HasCreateDate":true,"PageNumber":1,"PageSize":1}

application/xml, text/xml

Sample:

<InvoiceFilterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Filters">
  <PageNumber>1</PageNumber>
  <PageSize>1</PageSize>
  <HasCreateDate>true</HasCreateDate>
  <InvoiceNumber>sample string 1</InvoiceNumber>
  <Lease>sample string 3</Lease>
  <LessorCountry>sample string 2</LessorCountry>
  <Schedule>sample string 4</Schedule>
</InvoiceFilterModel>

application/x-www-form-urlencoded

Sample:

?InvoiceNumber=SampleString1&LessorCountry=SampleString2&Lease=SampleString3&Schedule=SampleString4&HasCreateDate=true&PageNumber=1&PageSize=1

Response Information

Resource Description

The InvoiceModel object, containing the collection of Invoices.

InvoiceModel

Name	Description	Type	Additional information
ErrorMessage	Optional error message provided by the method call.	string	None.
Invoices	Collection of Invoices being returned.	Collection of Invoice	None.
Message	Optional message provided by the method call.	string	None.
Paging	Contains information relevant to paging through a collection of objects.	PagingModel	None.
StatusCode	The HTTP Status Code of the method call.	HttpStatusCode	None.
Success	Boolean flag indicating the success or failure of the method call.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "StatusCode": 100,
  "Success": true,
  "Invoices": [
    {
      "InvoiceNumber": "sample string 1",
      "DueDate": "2025-04-25T21:09:19.9160671-05:00",
      "Currency": "sample string 2",
      "TotalDue": 3.0,
      "PeriodFrom": "2025-04-25T21:09:19.9160671-05:00",
      "PeriodTo": "2025-04-25T21:09:19.9160671-05:00",
      "BillingName": "sample string 4",
      "BillingAddress": "sample string 5",
      "BillingAttentionTo": "sample string 6",
      "BillingCity": "sample string 7",
      "BillingState": "sample string 8",
      "BillingPostalCode": "sample string 9",
      "RemitToName": "sample string 10",
      "RemitToAddress": "sample string 11",
      "RemitToAttentionTo": "sample string 12",
      "RemitToCity": "sample string 13",
      "RemitToState": "sample string 14",
      "RemitToPostalCode": "sample string 15",
      "Lease": "sample string 16",
      "Schedule": "sample string 17",
      "CreatedDate": "2025-04-25T21:09:19.9160671-05:00"
    },
    {
      "InvoiceNumber": "sample string 1",
      "DueDate": "2025-04-25T21:09:19.9160671-05:00",
      "Currency": "sample string 2",
      "TotalDue": 3.0,
      "PeriodFrom": "2025-04-25T21:09:19.9160671-05:00",
      "PeriodTo": "2025-04-25T21:09:19.9160671-05:00",
      "BillingName": "sample string 4",
      "BillingAddress": "sample string 5",
      "BillingAttentionTo": "sample string 6",
      "BillingCity": "sample string 7",
      "BillingState": "sample string 8",
      "BillingPostalCode": "sample string 9",
      "RemitToName": "sample string 10",
      "RemitToAddress": "sample string 11",
      "RemitToAttentionTo": "sample string 12",
      "RemitToCity": "sample string 13",
      "RemitToState": "sample string 14",
      "RemitToPostalCode": "sample string 15",
      "Lease": "sample string 16",
      "Schedule": "sample string 17",
      "CreatedDate": "2025-04-25T21:09:19.9160671-05:00"
    }
  ],
  "Paging": {
    "PageSize": 1,
    "PageNumber": 2,
    "TotalPages": 3,
    "TotalItems": 4
  },
  "ErrorMessage": "sample string 3"
}

application/octet-stream

Sample:

{"Message":"sample string 1","StatusCode":100,"Success":true,"Invoices":[{"InvoiceNumber":"sample string 1","DueDate":"2025-04-25T21:09:19.9160671-05:00","Currency":"sample string 2","TotalDue":3.0,"PeriodFrom":"2025-04-25T21:09:19.9160671-05:00","PeriodTo":"2025-04-25T21:09:19.9160671-05:00","BillingName":"sample string 4","BillingAddress":"sample string 5","BillingAttentionTo":"sample string 6","BillingCity":"sample string 7","BillingState":"sample string 8","BillingPostalCode":"sample string 9","RemitToName":"sample string 10","RemitToAddress":"sample string 11","RemitToAttentionTo":"sample string 12","RemitToCity":"sample string 13","RemitToState":"sample string 14","RemitToPostalCode":"sample string 15","Lease":"sample string 16","Schedule":"sample string 17","CreatedDate":"2025-04-25T21:09:19.9160671-05:00"},{"InvoiceNumber":"sample string 1","DueDate":"2025-04-25T21:09:19.9160671-05:00","Currency":"sample string 2","TotalDue":3.0,"PeriodFrom":"2025-04-25T21:09:19.9160671-05:00","PeriodTo":"2025-04-25T21:09:19.9160671-05:00","BillingName":"sample string 4","BillingAddress":"sample string 5","BillingAttentionTo":"sample string 6","BillingCity":"sample string 7","BillingState":"sample string 8","BillingPostalCode":"sample string 9","RemitToName":"sample string 10","RemitToAddress":"sample string 11","RemitToAttentionTo":"sample string 12","RemitToCity":"sample string 13","RemitToState":"sample string 14","RemitToPostalCode":"sample string 15","Lease":"sample string 16","Schedule":"sample string 17","CreatedDate":"2025-04-25T21:09:19.9160671-05:00"}],"Paging":{"PageSize":1,"PageNumber":2,"TotalPages":3,"TotalItems":4},"ErrorMessage":"sample string 3"}

application/xml, text/xml

Sample:

<InvoiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">sample string 3</ErrorMessage>
  <Message xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">sample string 1</Message>
  <StatusCode xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">Continue</StatusCode>
  <Success xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">true</Success>
  <Paging xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">
    <PageNumber>2</PageNumber>
    <PageSize>1</PageSize>
    <TotalItems>4</TotalItems>
    <TotalPages>3</TotalPages>
  </Paging>
  <Invoices>
    <Invoice>
      <BillingAddress>sample string 5</BillingAddress>
      <BillingAttentionTo>sample string 6</BillingAttentionTo>
      <BillingCity>sample string 7</BillingCity>
      <BillingName>sample string 4</BillingName>
      <BillingPostalCode>sample string 9</BillingPostalCode>
      <BillingState>sample string 8</BillingState>
      <CreatedDate>2025-04-25T21:09:19.9160671-05:00</CreatedDate>
      <Currency>sample string 2</Currency>
      <DueDate>2025-04-25T21:09:19.9160671-05:00</DueDate>
      <InvoiceNumber>sample string 1</InvoiceNumber>
      <Lease>sample string 16</Lease>
      <PeriodFrom>2025-04-25T21:09:19.9160671-05:00</PeriodFrom>
      <PeriodTo>2025-04-25T21:09:19.9160671-05:00</PeriodTo>
      <RemitToAddress>sample string 11</RemitToAddress>
      <RemitToAttentionTo>sample string 12</RemitToAttentionTo>
      <RemitToCity>sample string 13</RemitToCity>
      <RemitToName>sample string 10</RemitToName>
      <RemitToPostalCode>sample string 15</RemitToPostalCode>
      <RemitToState>sample string 14</RemitToState>
      <Schedule>sample string 17</Schedule>
      <TotalDue>3</TotalDue>
    </Invoice>
    <Invoice>
      <BillingAddress>sample string 5</BillingAddress>
      <BillingAttentionTo>sample string 6</BillingAttentionTo>
      <BillingCity>sample string 7</BillingCity>
      <BillingName>sample string 4</BillingName>
      <BillingPostalCode>sample string 9</BillingPostalCode>
      <BillingState>sample string 8</BillingState>
      <CreatedDate>2025-04-25T21:09:19.9160671-05:00</CreatedDate>
      <Currency>sample string 2</Currency>
      <DueDate>2025-04-25T21:09:19.9160671-05:00</DueDate>
      <InvoiceNumber>sample string 1</InvoiceNumber>
      <Lease>sample string 16</Lease>
      <PeriodFrom>2025-04-25T21:09:19.9160671-05:00</PeriodFrom>
      <PeriodTo>2025-04-25T21:09:19.9160671-05:00</PeriodTo>
      <RemitToAddress>sample string 11</RemitToAddress>
      <RemitToAttentionTo>sample string 12</RemitToAttentionTo>
      <RemitToCity>sample string 13</RemitToCity>
      <RemitToName>sample string 10</RemitToName>
      <RemitToPostalCode>sample string 15</RemitToPostalCode>
      <RemitToState>sample string 14</RemitToState>
      <Schedule>sample string 17</Schedule>
      <TotalDue>3</TotalDue>
    </Invoice>
  </Invoices>
</InvoiceModel>