GET api/Customer/GetCustomerInvoiceTransactions/{invoiceNumber}/{lastRefreshDate}

Gets the transactions for a selected invoice number

Request Information

URI Parameters

NameDescriptionTypeAdditional information
invoiceNumber

Invoice Number for which transactions must be returned

string

Required

lastRefreshDate

Optional: last date that the data set was refreshed (null if date not required)

date

Required

Body Parameters

None.

Response Information

Resource Description

Returns the Transaction object

CustomerInvoiceTransactionsViewModel
NameDescriptionTypeAdditional information
transactions

Collection of Transaction

None.

apiResponse

APIResponseMessage

None.

Response Formats

application/json, text/json

Sample:
{
  "transactions": [
    {
      "Description": "sample string 1",
      "Date": "2024-03-05T10:39:41.8643118+00:00",
      "Amount": 2.0,
      "Ispaid": true
    },
    {
      "Description": "sample string 1",
      "Date": "2024-03-05T10:39:41.8643118+00:00",
      "Amount": 2.0,
      "Ispaid": true
    }
  ],
  "apiResponse": {
    "HttpStatusCode": "sample string 1",
    "ReasonPhrase": "sample string 2",
    "ExceptionMessage": "sample string 3",
    "GeneralMessage": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<CustomerInvoiceTransactionsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Customer">
  <apiResponse xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.Core.Models">
    <d2p1:ExceptionMessage>sample string 3</d2p1:ExceptionMessage>
    <d2p1:GeneralMessage>sample string 4</d2p1:GeneralMessage>
    <d2p1:HttpStatusCode>sample string 1</d2p1:HttpStatusCode>
    <d2p1:ReasonPhrase>sample string 2</d2p1:ReasonPhrase>
  </apiResponse>
  <transactions xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.Core.Models.Customer">
    <d2p1:Transaction>
      <d2p1:Amount>2</d2p1:Amount>
      <d2p1:Date>2024-03-05T10:39:41.8643118+00:00</d2p1:Date>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:Ispaid>true</d2p1:Ispaid>
    </d2p1:Transaction>
    <d2p1:Transaction>
      <d2p1:Amount>2</d2p1:Amount>
      <d2p1:Date>2024-03-05T10:39:41.8643118+00:00</d2p1:Date>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:Ispaid>true</d2p1:Ispaid>
    </d2p1:Transaction>
  </transactions>
</CustomerInvoiceTransactionsViewModel>