MyCSI API - Documentation

GET Invoice/Assets/{id}

Method used to fetch a collection of Invoice Assets.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Security token provided via the Authentication method.

 globally unique identifier

Required

Body Parameters

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

InvoiceAssetFilterModel
NameDescriptionTypeAdditional information
CustomerReference

Optional, the customer reference of the Invoice Asset.

 string

None.
InvoiceNumber

Optional, the identifier of the Invoice to which the Invoice Asset belongs.

 string

None.
Lease

Optional, the Lease to which the Invoice Asset 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",
  "CustomerReference": "sample string 5",
  "PageNumber": 1,
  "PageSize": 1
}

application/octet-stream

Sample: 
{"InvoiceNumber":"sample string 1","LessorCountry":"sample string 2","Lease":"sample string 3","Schedule":"sample string 4","CustomerReference":"sample string 5","PageNumber":1,"PageSize":1}

application/xml, text/xml

Sample: 
<InvoiceAssetFilterModel 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>
  <CustomerReference>sample string 5</CustomerReference>
  <InvoiceNumber>sample string 1</InvoiceNumber>
  <Lease>sample string 3</Lease>
  <LessorCountry>sample string 2</LessorCountry>
  <Schedule>sample string 4</Schedule>
</InvoiceAssetFilterModel>

application/x-www-form-urlencoded

Sample: 
?InvoiceNumber=SampleString1&LessorCountry=SampleString2&Lease=SampleString3&Schedule=SampleString4&CustomerReference=SampleString5&PageNumber=1&PageSize=1

Response Information

Resource Description

The InvoiceModel object, containing the collection of Invoice Assets.

InvoiceAssetModel
NameDescriptionTypeAdditional information
ErrorMessage

Optional error message provided by the method call.

 string

None.
InvoiceAssets

Collection of Invoice Assets being returned.

 Collection of InvoiceAsset

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: 
{
  "InvoiceAssets": [
    {
      "InvoiceNumber": "sample string 1",
      "PeriodFrom": "2025-10-25T13:34:42.1070597-05:00",
      "PeriodTo": "2025-10-25T13:34:42.1070597-05:00",
      "DueDate": "2025-10-25T13:34:42.1070597-05:00",
      "Lease": "sample string 2",
      "Schedule": "sample string 3",
      "Serial": "sample string 4",
      "Manufacturer": "sample string 5",
      "Model": "sample string 6",
      "SiteAddress": "sample string 7",
      "SiteCity": "sample string 8",
      "SiteState": "sample string 9",
      "SitePostalCode": "sample string 10",
      "CustomerReference": "sample string 11",
      "TaxRate": 1.0,
      "DateInstalled": "2025-10-25T13:34:42.1070597-05:00",
      "Currency": "sample string 12",
      "PeriodRent": 1.0,
      "Rent": 1.0,
      "Tax": 1.0,
      "TaxGst": 1.0,
      "TaxPst": 1.0,
      "TaxOther": 1.0,
      "BillingName": "sample string 13",
      "BillingAddress": "sample string 14",
      "BillingAttentionTo": "sample string 15",
      "BillingCity": "sample string 16",
      "BillingState": "sample string 17",
      "BillingPostalCode": "sample string 18",
      "BillingCountry": "sample string 19",
      "RemitToName": "sample string 20",
      "RemitToAddress": "sample string 21",
      "RemitToAttentionTo": "sample string 22",
      "RemitToCity": "sample string 23",
      "RemitToState": "sample string 24",
      "RemitToPostalCode": "sample string 25",
      "CDF01": "sample string 26",
      "CDF02": "sample string 27",
      "CDF03": "sample string 28",
      "CDF04": "sample string 29",
      "CDF05": "sample string 30",
      "CDF06": "sample string 31",
      "CDF07": "sample string 32",
      "CDF08": "sample string 33",
      "CDF09": "sample string 34",
      "CDF10": "sample string 35",
      "InventoryId": 1
    },
    {
      "InvoiceNumber": "sample string 1",
      "PeriodFrom": "2025-10-25T13:34:42.1070597-05:00",
      "PeriodTo": "2025-10-25T13:34:42.1070597-05:00",
      "DueDate": "2025-10-25T13:34:42.1070597-05:00",
      "Lease": "sample string 2",
      "Schedule": "sample string 3",
      "Serial": "sample string 4",
      "Manufacturer": "sample string 5",
      "Model": "sample string 6",
      "SiteAddress": "sample string 7",
      "SiteCity": "sample string 8",
      "SiteState": "sample string 9",
      "SitePostalCode": "sample string 10",
      "CustomerReference": "sample string 11",
      "TaxRate": 1.0,
      "DateInstalled": "2025-10-25T13:34:42.1070597-05:00",
      "Currency": "sample string 12",
      "PeriodRent": 1.0,
      "Rent": 1.0,
      "Tax": 1.0,
      "TaxGst": 1.0,
      "TaxPst": 1.0,
      "TaxOther": 1.0,
      "BillingName": "sample string 13",
      "BillingAddress": "sample string 14",
      "BillingAttentionTo": "sample string 15",
      "BillingCity": "sample string 16",
      "BillingState": "sample string 17",
      "BillingPostalCode": "sample string 18",
      "BillingCountry": "sample string 19",
      "RemitToName": "sample string 20",
      "RemitToAddress": "sample string 21",
      "RemitToAttentionTo": "sample string 22",
      "RemitToCity": "sample string 23",
      "RemitToState": "sample string 24",
      "RemitToPostalCode": "sample string 25",
      "CDF01": "sample string 26",
      "CDF02": "sample string 27",
      "CDF03": "sample string 28",
      "CDF04": "sample string 29",
      "CDF05": "sample string 30",
      "CDF06": "sample string 31",
      "CDF07": "sample string 32",
      "CDF08": "sample string 33",
      "CDF09": "sample string 34",
      "CDF10": "sample string 35",
      "InventoryId": 1
    }
  ],
  "Paging": {
    "PageSize": 1,
    "PageNumber": 2,
    "TotalPages": 3,
    "TotalItems": 4
  },
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": "sample string 3",
  "StatusCode": 100
}

application/octet-stream

Sample: 
{"InvoiceAssets":[{"InvoiceNumber":"sample string 1","PeriodFrom":"2025-10-25T13:34:42.1070597-05:00","PeriodTo":"2025-10-25T13:34:42.1070597-05:00","DueDate":"2025-10-25T13:34:42.1070597-05:00","Lease":"sample string 2","Schedule":"sample string 3","Serial":"sample string 4","Manufacturer":"sample string 5","Model":"sample string 6","SiteAddress":"sample string 7","SiteCity":"sample string 8","SiteState":"sample string 9","SitePostalCode":"sample string 10","CustomerReference":"sample string 11","TaxRate":1.0,"DateInstalled":"2025-10-25T13:34:42.1070597-05:00","Currency":"sample string 12","PeriodRent":1.0,"Rent":1.0,"Tax":1.0,"TaxGst":1.0,"TaxPst":1.0,"TaxOther":1.0,"BillingName":"sample string 13","BillingAddress":"sample string 14","BillingAttentionTo":"sample string 15","BillingCity":"sample string 16","BillingState":"sample string 17","BillingPostalCode":"sample string 18","BillingCountry":"sample string 19","RemitToName":"sample string 20","RemitToAddress":"sample string 21","RemitToAttentionTo":"sample string 22","RemitToCity":"sample string 23","RemitToState":"sample string 24","RemitToPostalCode":"sample string 25","CDF01":"sample string 26","CDF02":"sample string 27","CDF03":"sample string 28","CDF04":"sample string 29","CDF05":"sample string 30","CDF06":"sample string 31","CDF07":"sample string 32","CDF08":"sample string 33","CDF09":"sample string 34","CDF10":"sample string 35","InventoryId":1},{"InvoiceNumber":"sample string 1","PeriodFrom":"2025-10-25T13:34:42.1070597-05:00","PeriodTo":"2025-10-25T13:34:42.1070597-05:00","DueDate":"2025-10-25T13:34:42.1070597-05:00","Lease":"sample string 2","Schedule":"sample string 3","Serial":"sample string 4","Manufacturer":"sample string 5","Model":"sample string 6","SiteAddress":"sample string 7","SiteCity":"sample string 8","SiteState":"sample string 9","SitePostalCode":"sample string 10","CustomerReference":"sample string 11","TaxRate":1.0,"DateInstalled":"2025-10-25T13:34:42.1070597-05:00","Currency":"sample string 12","PeriodRent":1.0,"Rent":1.0,"Tax":1.0,"TaxGst":1.0,"TaxPst":1.0,"TaxOther":1.0,"BillingName":"sample string 13","BillingAddress":"sample string 14","BillingAttentionTo":"sample string 15","BillingCity":"sample string 16","BillingState":"sample string 17","BillingPostalCode":"sample string 18","BillingCountry":"sample string 19","RemitToName":"sample string 20","RemitToAddress":"sample string 21","RemitToAttentionTo":"sample string 22","RemitToCity":"sample string 23","RemitToState":"sample string 24","RemitToPostalCode":"sample string 25","CDF01":"sample string 26","CDF02":"sample string 27","CDF03":"sample string 28","CDF04":"sample string 29","CDF05":"sample string 30","CDF06":"sample string 31","CDF07":"sample string 32","CDF08":"sample string 33","CDF09":"sample string 34","CDF10":"sample string 35","InventoryId":1}],"Paging":{"PageSize":1,"PageNumber":2,"TotalPages":3,"TotalItems":4},"Success":true,"Message":"sample string 2","ErrorMessage":"sample string 3","StatusCode":100}

application/xml, text/xml

Sample: 
<InvoiceAssetModel 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 2</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>
  <InvoiceAssets>
    <InvoiceAsset>
      <BillingAddress>sample string 14</BillingAddress>
      <BillingAttentionTo>sample string 15</BillingAttentionTo>
      <BillingCity>sample string 16</BillingCity>
      <BillingCountry>sample string 19</BillingCountry>
      <BillingName>sample string 13</BillingName>
      <BillingPostalCode>sample string 18</BillingPostalCode>
      <BillingState>sample string 17</BillingState>
      <CDF01>sample string 26</CDF01>
      <CDF02>sample string 27</CDF02>
      <CDF03>sample string 28</CDF03>
      <CDF04>sample string 29</CDF04>
      <CDF05>sample string 30</CDF05>
      <CDF06>sample string 31</CDF06>
      <CDF07>sample string 32</CDF07>
      <CDF08>sample string 33</CDF08>
      <CDF09>sample string 34</CDF09>
      <CDF10>sample string 35</CDF10>
      <Currency>sample string 12</Currency>
      <CustomerReference>sample string 11</CustomerReference>
      <DateInstalled>2025-10-25T13:34:42.1070597-05:00</DateInstalled>
      <DueDate>2025-10-25T13:34:42.1070597-05:00</DueDate>
      <InventoryId>1</InventoryId>
      <InvoiceNumber>sample string 1</InvoiceNumber>
      <Lease>sample string 2</Lease>
      <Manufacturer>sample string 5</Manufacturer>
      <Model>sample string 6</Model>
      <PeriodFrom>2025-10-25T13:34:42.1070597-05:00</PeriodFrom>
      <PeriodRent>1</PeriodRent>
      <PeriodTo>2025-10-25T13:34:42.1070597-05:00</PeriodTo>
      <RemitToAddress>sample string 21</RemitToAddress>
      <RemitToAttentionTo>sample string 22</RemitToAttentionTo>
      <RemitToCity>sample string 23</RemitToCity>
      <RemitToName>sample string 20</RemitToName>
      <RemitToPostalCode>sample string 25</RemitToPostalCode>
      <RemitToState>sample string 24</RemitToState>
      <Rent>1</Rent>
      <Schedule>sample string 3</Schedule>
      <Serial>sample string 4</Serial>
      <SiteAddress>sample string 7</SiteAddress>
      <SiteCity>sample string 8</SiteCity>
      <SitePostalCode>sample string 10</SitePostalCode>
      <SiteState>sample string 9</SiteState>
      <Tax>1</Tax>
      <TaxGst>1</TaxGst>
      <TaxOther>1</TaxOther>
      <TaxPst>1</TaxPst>
      <TaxRate>1</TaxRate>
    </InvoiceAsset>
    <InvoiceAsset>
      <BillingAddress>sample string 14</BillingAddress>
      <BillingAttentionTo>sample string 15</BillingAttentionTo>
      <BillingCity>sample string 16</BillingCity>
      <BillingCountry>sample string 19</BillingCountry>
      <BillingName>sample string 13</BillingName>
      <BillingPostalCode>sample string 18</BillingPostalCode>
      <BillingState>sample string 17</BillingState>
      <CDF01>sample string 26</CDF01>
      <CDF02>sample string 27</CDF02>
      <CDF03>sample string 28</CDF03>
      <CDF04>sample string 29</CDF04>
      <CDF05>sample string 30</CDF05>
      <CDF06>sample string 31</CDF06>
      <CDF07>sample string 32</CDF07>
      <CDF08>sample string 33</CDF08>
      <CDF09>sample string 34</CDF09>
      <CDF10>sample string 35</CDF10>
      <Currency>sample string 12</Currency>
      <CustomerReference>sample string 11</CustomerReference>
      <DateInstalled>2025-10-25T13:34:42.1070597-05:00</DateInstalled>
      <DueDate>2025-10-25T13:34:42.1070597-05:00</DueDate>
      <InventoryId>1</InventoryId>
      <InvoiceNumber>sample string 1</InvoiceNumber>
      <Lease>sample string 2</Lease>
      <Manufacturer>sample string 5</Manufacturer>
      <Model>sample string 6</Model>
      <PeriodFrom>2025-10-25T13:34:42.1070597-05:00</PeriodFrom>
      <PeriodRent>1</PeriodRent>
      <PeriodTo>2025-10-25T13:34:42.1070597-05:00</PeriodTo>
      <RemitToAddress>sample string 21</RemitToAddress>
      <RemitToAttentionTo>sample string 22</RemitToAttentionTo>
      <RemitToCity>sample string 23</RemitToCity>
      <RemitToName>sample string 20</RemitToName>
      <RemitToPostalCode>sample string 25</RemitToPostalCode>
      <RemitToState>sample string 24</RemitToState>
      <Rent>1</Rent>
      <Schedule>sample string 3</Schedule>
      <Serial>sample string 4</Serial>
      <SiteAddress>sample string 7</SiteAddress>
      <SiteCity>sample string 8</SiteCity>
      <SitePostalCode>sample string 10</SitePostalCode>
      <SiteState>sample string 9</SiteState>
      <Tax>1</Tax>
      <TaxGst>1</TaxGst>
      <TaxOther>1</TaxOther>
      <TaxPst>1</TaxPst>
      <TaxRate>1</TaxRate>
    </InvoiceAsset>
  </InvoiceAssets>
</InvoiceAssetModel>