GET api/CustomerStatement/Get?apiKey={apiKey}&customerID={customerID}&fromDate={fromDate}&toDate={toDate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

string

Required

customerID

globally unique identifier

Required

fromDate

date

None.

toDate

date

None.

Body Parameters

None.

Response Information

Resource Description

CustomerStatementReport
NameDescriptionTypeAdditional information
CustomerStatementDetail

Collection of StatementOfAccount

None.

CustomerStatementSummary

CustomerStatementSummary

None.

Customer

ContactInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "CustomerStatementDetail": [
    {
      "TransactionID": "4b2963a2-c0ee-4e60-b8f7-60edc21b4479",
      "TransactionDate": "2024-06-14T06:51:08.7620402+04:00",
      "TransactionNo": "sample string 3",
      "FinanceTranType": 1,
      "Customer": {
        "CustomerType": 0,
        "TitleType": 0,
        "Name": "sample string 1",
        "Address": "sample string 2",
        "Email": "sample string 3",
        "ContactNo": "sample string 4",
        "CountryState": {
          "StateCode": "sample string 2",
          "StateName": "sample string 3",
          "CountryCode": "sample string 4",
          "CountryName": "sample string 5",
          "NationalityCode": "sample string 6",
          "NationalityName": "sample string 7"
        },
        "Id": "a0c6273d-73fe-41f8-aae1-4bb34080f6f5",
        "Code": "sample string 9"
      },
      "Debit": 4.1,
      "Credit": 5.1,
      "Balance": 6.1,
      "Note": "sample string 7",
      "AgreementID": "7208aea2-5987-4eb3-879f-92f3cd39942e",
      "AgreementNo": "sample string 9",
      "TransactionType": 0,
      "InvoiceID": "d775ca92-6712-44c9-87b8-2a918798204d",
      "AdvancePaymentBalance": 11.1,
      "PaymentApprovalStatus": 0,
      "AgreementStatus": 0
    },
    {
      "TransactionID": "4b2963a2-c0ee-4e60-b8f7-60edc21b4479",
      "TransactionDate": "2024-06-14T06:51:08.7620402+04:00",
      "TransactionNo": "sample string 3",
      "FinanceTranType": 1,
      "Customer": {
        "CustomerType": 0,
        "TitleType": 0,
        "Name": "sample string 1",
        "Address": "sample string 2",
        "Email": "sample string 3",
        "ContactNo": "sample string 4",
        "CountryState": {
          "StateCode": "sample string 2",
          "StateName": "sample string 3",
          "CountryCode": "sample string 4",
          "CountryName": "sample string 5",
          "NationalityCode": "sample string 6",
          "NationalityName": "sample string 7"
        },
        "Id": "a0c6273d-73fe-41f8-aae1-4bb34080f6f5",
        "Code": "sample string 9"
      },
      "Debit": 4.1,
      "Credit": 5.1,
      "Balance": 6.1,
      "Note": "sample string 7",
      "AgreementID": "7208aea2-5987-4eb3-879f-92f3cd39942e",
      "AgreementNo": "sample string 9",
      "TransactionType": 0,
      "InvoiceID": "d775ca92-6712-44c9-87b8-2a918798204d",
      "AdvancePaymentBalance": 11.1,
      "PaymentApprovalStatus": 0,
      "AgreementStatus": 0
    }
  ],
  "CustomerStatementSummary": {
    "TotalDebit": 1.1,
    "TotalCredit": 2.1,
    "Balance": -1.0
  },
  "Customer": {
    "CustomerType": 0,
    "TitleType": 0,
    "Name": "sample string 1",
    "Address": "sample string 2",
    "Email": "sample string 3",
    "ContactNo": "sample string 4",
    "CountryState": {
      "StateCode": "sample string 2",
      "StateName": "sample string 3",
      "CountryCode": "sample string 4",
      "CountryName": "sample string 5",
      "NationalityCode": "sample string 6",
      "NationalityName": "sample string 7"
    },
    "Id": "a0c6273d-73fe-41f8-aae1-4bb34080f6f5",
    "Code": "sample string 9"
  }
}

application/xml, text/xml

Sample:
<CustomerStatementReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity.Report">
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fleetlet.Entity.Customer">
    <Code xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">sample string 9</Code>
    <Id xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">a0c6273d-73fe-41f8-aae1-4bb34080f6f5</Id>
    <d2p1:Address>sample string 2</d2p1:Address>
    <d2p1:ContactNo>sample string 4</d2p1:ContactNo>
    <d2p1:CountryState xmlns:d3p1="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">
      <d3p1:CountryCode>sample string 4</d3p1:CountryCode>
      <d3p1:CountryName>sample string 5</d3p1:CountryName>
      <d3p1:NationalityCode>sample string 6</d3p1:NationalityCode>
      <d3p1:NationalityName>sample string 7</d3p1:NationalityName>
      <d3p1:StateCode>sample string 2</d3p1:StateCode>
      <d3p1:StateName>sample string 3</d3p1:StateName>
    </d2p1:CountryState>
    <d2p1:CustomerType>All</d2p1:CustomerType>
    <d2p1:Email>sample string 3</d2p1:Email>
    <d2p1:Name>sample string 1</d2p1:Name>
    <d2p1:TitleType>Mr</d2p1:TitleType>
  </Customer>
  <CustomerStatementDetail xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fleetlet.Entity.Finance">
    <d2p1:StatementOfAccount>
      <d2p1:AdvancePaymentBalance>11.1</d2p1:AdvancePaymentBalance>
      <d2p1:AgreementID>7208aea2-5987-4eb3-879f-92f3cd39942e</d2p1:AgreementID>
      <d2p1:AgreementNo>sample string 9</d2p1:AgreementNo>
      <d2p1:AgreementStatus>None</d2p1:AgreementStatus>
      <d2p1:Balance>6.1</d2p1:Balance>
      <d2p1:Credit>5.1</d2p1:Credit>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/Fleetlet.Entity.Customer">
        <Code xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">sample string 9</Code>
        <Id xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">a0c6273d-73fe-41f8-aae1-4bb34080f6f5</Id>
        <d4p1:Address>sample string 2</d4p1:Address>
        <d4p1:ContactNo>sample string 4</d4p1:ContactNo>
        <d4p1:CountryState xmlns:d5p1="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">
          <d5p1:CountryCode>sample string 4</d5p1:CountryCode>
          <d5p1:CountryName>sample string 5</d5p1:CountryName>
          <d5p1:NationalityCode>sample string 6</d5p1:NationalityCode>
          <d5p1:NationalityName>sample string 7</d5p1:NationalityName>
          <d5p1:StateCode>sample string 2</d5p1:StateCode>
          <d5p1:StateName>sample string 3</d5p1:StateName>
        </d4p1:CountryState>
        <d4p1:CustomerType>All</d4p1:CustomerType>
        <d4p1:Email>sample string 3</d4p1:Email>
        <d4p1:Name>sample string 1</d4p1:Name>
        <d4p1:TitleType>Mr</d4p1:TitleType>
      </d2p1:Customer>
      <d2p1:Debit>4.1</d2p1:Debit>
      <d2p1:FinanceTranType>Invoice</d2p1:FinanceTranType>
      <d2p1:InvoiceID>d775ca92-6712-44c9-87b8-2a918798204d</d2p1:InvoiceID>
      <d2p1:Note>sample string 7</d2p1:Note>
      <d2p1:PaymentApprovalStatus>None</d2p1:PaymentApprovalStatus>
      <d2p1:TransactionDate>2024-06-14T06:51:08.7620402+04:00</d2p1:TransactionDate>
      <d2p1:TransactionID>4b2963a2-c0ee-4e60-b8f7-60edc21b4479</d2p1:TransactionID>
      <d2p1:TransactionNo>sample string 3</d2p1:TransactionNo>
      <d2p1:TransactionType>None</d2p1:TransactionType>
    </d2p1:StatementOfAccount>
    <d2p1:StatementOfAccount>
      <d2p1:AdvancePaymentBalance>11.1</d2p1:AdvancePaymentBalance>
      <d2p1:AgreementID>7208aea2-5987-4eb3-879f-92f3cd39942e</d2p1:AgreementID>
      <d2p1:AgreementNo>sample string 9</d2p1:AgreementNo>
      <d2p1:AgreementStatus>None</d2p1:AgreementStatus>
      <d2p1:Balance>6.1</d2p1:Balance>
      <d2p1:Credit>5.1</d2p1:Credit>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/Fleetlet.Entity.Customer">
        <Code xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">sample string 9</Code>
        <Id xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">a0c6273d-73fe-41f8-aae1-4bb34080f6f5</Id>
        <d4p1:Address>sample string 2</d4p1:Address>
        <d4p1:ContactNo>sample string 4</d4p1:ContactNo>
        <d4p1:CountryState xmlns:d5p1="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">
          <d5p1:CountryCode>sample string 4</d5p1:CountryCode>
          <d5p1:CountryName>sample string 5</d5p1:CountryName>
          <d5p1:NationalityCode>sample string 6</d5p1:NationalityCode>
          <d5p1:NationalityName>sample string 7</d5p1:NationalityName>
          <d5p1:StateCode>sample string 2</d5p1:StateCode>
          <d5p1:StateName>sample string 3</d5p1:StateName>
        </d4p1:CountryState>
        <d4p1:CustomerType>All</d4p1:CustomerType>
        <d4p1:Email>sample string 3</d4p1:Email>
        <d4p1:Name>sample string 1</d4p1:Name>
        <d4p1:TitleType>Mr</d4p1:TitleType>
      </d2p1:Customer>
      <d2p1:Debit>4.1</d2p1:Debit>
      <d2p1:FinanceTranType>Invoice</d2p1:FinanceTranType>
      <d2p1:InvoiceID>d775ca92-6712-44c9-87b8-2a918798204d</d2p1:InvoiceID>
      <d2p1:Note>sample string 7</d2p1:Note>
      <d2p1:PaymentApprovalStatus>None</d2p1:PaymentApprovalStatus>
      <d2p1:TransactionDate>2024-06-14T06:51:08.7620402+04:00</d2p1:TransactionDate>
      <d2p1:TransactionID>4b2963a2-c0ee-4e60-b8f7-60edc21b4479</d2p1:TransactionID>
      <d2p1:TransactionNo>sample string 3</d2p1:TransactionNo>
      <d2p1:TransactionType>None</d2p1:TransactionType>
    </d2p1:StatementOfAccount>
  </CustomerStatementDetail>
  <CustomerStatementSummary>
    <TotalCredit>2.1</TotalCredit>
    <TotalDebit>1.1</TotalDebit>
  </CustomerStatementSummary>
</CustomerStatementReport>