GET api/finance/getInvoice?invoiceNumber={invoiceNumber}

Retrieve 1 specific invoice

Request Information

URI Parameters

Name	Description	Type	Additional information
invoiceNumber		integer	Required

Body Parameters

None.

Response Information

Resource Description

A detailed invoice

ResponseGetInvoice

Name	Type	Additional information
InvoiceNumber	integer	None.
CreateDate	date	None.
PartnerName	string	None.
Amount	decimal number	None.
Status	StatusInvoiceEnum	None.
DebtorNumber	string	None.
InvoiceDate	date	None.
ExpirationDate	date	None.
CollectionDate	date	None.
ClientReference	string	None.
Description	string	None.
CollectionId	string	None.
Authorization	string	None.
InvoiceAddress	AddressForInvoice	None.
DeliveryAddress	AddressForInvoice	None.
InvoiceLines	Collection of InvoiceLineItem	None.
TotalAmountSold	decimal number	None.
TotalAmountPurchase	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "InvoiceNumber": 1,
  "CreateDate": "2024-04-19T02:39:46.9104732+02:00",
  "PartnerName": "sample string 3",
  "Amount": 4.0,
  "Status": 0,
  "DebtorNumber": "sample string 5",
  "InvoiceDate": "2024-04-19T02:39:46.9104732+02:00",
  "ExpirationDate": "2024-04-19T02:39:46.9104732+02:00",
  "CollectionDate": "2024-04-19T02:39:46.9104732+02:00",
  "ClientReference": "sample string 8",
  "Description": "sample string 9",
  "CollectionId": "sample string 10",
  "Authorization": "sample string 11",
  "InvoiceAddress": {
    "Name": "sample string 1",
    "Street": "sample string 2",
    "HouseNumber": "sample string 3",
    "HouseNumberExt": "sample string 4",
    "PostalCode": "sample string 5",
    "StateProvence": "sample string 6",
    "Country": "sample string 7"
  },
  "DeliveryAddress": {
    "Name": "sample string 1",
    "Street": "sample string 2",
    "HouseNumber": "sample string 3",
    "HouseNumberExt": "sample string 4",
    "PostalCode": "sample string 5",
    "StateProvence": "sample string 6",
    "Country": "sample string 7"
  },
  "InvoiceLines": [
    {
      "InvoiceLineId": 1,
      "Quantity": 2.0,
      "ProductNumber": "sample string 3",
      "Purpose": "sample string 4",
      "Desciption": "sample string 5",
      "Price": 6.0,
      "Vat": 7.0,
      "VatAmount": 8.0,
      "PurchaseAmount": 9.0,
      "VatType": "sample string 10",
      "PurchaseLines": [
        {
          "SerialNumber": "sample string 1",
          "SupplierDebNr": "sample string 2",
          "SupplierName": "sample string 3",
          "Purpose": "sample string 4",
          "Purchase": 5.0
        },
        {
          "SerialNumber": "sample string 1",
          "SupplierDebNr": "sample string 2",
          "SupplierName": "sample string 3",
          "Purpose": "sample string 4",
          "Purchase": 5.0
        }
      ]
    },
    {
      "InvoiceLineId": 1,
      "Quantity": 2.0,
      "ProductNumber": "sample string 3",
      "Purpose": "sample string 4",
      "Desciption": "sample string 5",
      "Price": 6.0,
      "Vat": 7.0,
      "VatAmount": 8.0,
      "PurchaseAmount": 9.0,
      "VatType": "sample string 10",
      "PurchaseLines": [
        {
          "SerialNumber": "sample string 1",
          "SupplierDebNr": "sample string 2",
          "SupplierName": "sample string 3",
          "Purpose": "sample string 4",
          "Purchase": 5.0
        },
        {
          "SerialNumber": "sample string 1",
          "SupplierDebNr": "sample string 2",
          "SupplierName": "sample string 3",
          "Purpose": "sample string 4",
          "Purchase": 5.0
        }
      ]
    }
  ],
  "TotalAmountSold": 12.0,
  "TotalAmountPurchase": 13.0
}

application/xml, text/xml

Sample:

<ResponseGetInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MaxRetail.Finance.DTO">
  <Amount>4</Amount>
  <Authorization>sample string 11</Authorization>
  <ClientReference>sample string 8</ClientReference>
  <CollectionDate>2024-04-19T02:39:46.9104732+02:00</CollectionDate>
  <CollectionId>sample string 10</CollectionId>
  <CreateDate>2024-04-19T02:39:46.9104732+02:00</CreateDate>
  <DebtorNumber>sample string 5</DebtorNumber>
  <DeliveryAddress>
    <Country>sample string 7</Country>
    <HouseNumber>sample string 3</HouseNumber>
    <HouseNumberExt>sample string 4</HouseNumberExt>
    <Name>sample string 1</Name>
    <PostalCode>sample string 5</PostalCode>
    <StateProvence>sample string 6</StateProvence>
    <Street>sample string 2</Street>
  </DeliveryAddress>
  <Description>sample string 9</Description>
  <ExpirationDate>2024-04-19T02:39:46.9104732+02:00</ExpirationDate>
  <InvoiceAddress>
    <Country>sample string 7</Country>
    <HouseNumber>sample string 3</HouseNumber>
    <HouseNumberExt>sample string 4</HouseNumberExt>
    <Name>sample string 1</Name>
    <PostalCode>sample string 5</PostalCode>
    <StateProvence>sample string 6</StateProvence>
    <Street>sample string 2</Street>
  </InvoiceAddress>
  <InvoiceDate>2024-04-19T02:39:46.9104732+02:00</InvoiceDate>
  <InvoiceLines>
    <InvoiceLineItem>
      <Desciption>sample string 5</Desciption>
      <InvoiceLineId>1</InvoiceLineId>
      <Price>6</Price>
      <ProductNumber>sample string 3</ProductNumber>
      <PurchaseAmount>9</PurchaseAmount>
      <PurchaseLines>
        <InvoicePurchaseLine>
          <Purchase>5</Purchase>
          <Purpose>sample string 4</Purpose>
          <SerialNumber>sample string 1</SerialNumber>
          <SupplierDebNr>sample string 2</SupplierDebNr>
          <SupplierName>sample string 3</SupplierName>
        </InvoicePurchaseLine>
        <InvoicePurchaseLine>
          <Purchase>5</Purchase>
          <Purpose>sample string 4</Purpose>
          <SerialNumber>sample string 1</SerialNumber>
          <SupplierDebNr>sample string 2</SupplierDebNr>
          <SupplierName>sample string 3</SupplierName>
        </InvoicePurchaseLine>
      </PurchaseLines>
      <Purpose>sample string 4</Purpose>
      <Quantity>2</Quantity>
      <Vat>7</Vat>
      <VatAmount>8</VatAmount>
      <VatType>sample string 10</VatType>
    </InvoiceLineItem>
    <InvoiceLineItem>
      <Desciption>sample string 5</Desciption>
      <InvoiceLineId>1</InvoiceLineId>
      <Price>6</Price>
      <ProductNumber>sample string 3</ProductNumber>
      <PurchaseAmount>9</PurchaseAmount>
      <PurchaseLines>
        <InvoicePurchaseLine>
          <Purchase>5</Purchase>
          <Purpose>sample string 4</Purpose>
          <SerialNumber>sample string 1</SerialNumber>
          <SupplierDebNr>sample string 2</SupplierDebNr>
          <SupplierName>sample string 3</SupplierName>
        </InvoicePurchaseLine>
        <InvoicePurchaseLine>
          <Purchase>5</Purchase>
          <Purpose>sample string 4</Purpose>
          <SerialNumber>sample string 1</SerialNumber>
          <SupplierDebNr>sample string 2</SupplierDebNr>
          <SupplierName>sample string 3</SupplierName>
        </InvoicePurchaseLine>
      </PurchaseLines>
      <Purpose>sample string 4</Purpose>
      <Quantity>2</Quantity>
      <Vat>7</Vat>
      <VatAmount>8</VatAmount>
      <VatType>sample string 10</VatType>
    </InvoiceLineItem>
  </InvoiceLines>
  <InvoiceNumber>1</InvoiceNumber>
  <PartnerName>sample string 3</PartnerName>
  <Status>Open</Status>
  <TotalAmountPurchase>13</TotalAmountPurchase>
  <TotalAmountSold>12</TotalAmountSold>
</ResponseGetInvoice>