POST Finance/Invoice

GetInvoice

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Lang": "sample string 2",
  "StoreID": 3
}

application/xml, text/xml

Sample:

<GetInvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Finance">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 2</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">3</StoreID>
  <ID>1</ID>
</GetInvoiceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Invoice

Name	Description	Type	Additional information
ID		integer	None.
Number		string	None.
Price		OrderPriceBreakdown	None.
IssueDate	The date this invoice has been issued	date	None.
DueDate	The date this invoice is due	date	None.
PaymentDate	The date this invoice has been paid	date	None.
Observations		string	None.
Url		string	String length: inclusive between 0 and 50
CustomerContact		ContactEntity	None.
SupplierContact		ContactEntity	None.
Items		Collection of InvoiceItem	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Number": "sample string 2",
  "Price": {
    "ItemsBase": 1.0,
    "ShippingsBase": 2.0,
    "Base": 3.0,
    "Tax": 4.0,
    "EquivalenceSurcharge": 5.0,
    "Discount": 6.0,
    "SubTotal": 7.0,
    "Amount": 8.0
  },
  "IssueDate": "2025-12-06T09:17:18.5706704+01:00",
  "DueDate": "2025-12-06T09:17:18.5706704+01:00",
  "PaymentDate": "2025-12-06T09:17:18.5706704+01:00",
  "Observations": "sample string 5",
  "Url": "sample string 6",
  "CustomerContact": {
    "Alias": "sample string 1",
    "Name": "sample string 2",
    "Surnames": "sample string 3",
    "VatIdentifier": "sample string 4",
    "Email": "sample string 5",
    "WebURL": "sample string 6",
    "Phone": "sample string 7",
    "Addressee": "sample string 8",
    "Street": "sample string 9",
    "PostalCode": "sample string 10",
    "Place": {
      "ID": 1,
      "Name": "sample string 2",
      "PostalCode": "sample string 3",
      "LocalityID": 4
    },
    "Country": {
      "ID": 1,
      "Name": "sample string 2",
      "Code": "sample string 3"
    }
  },
  "SupplierContact": {
    "Alias": "sample string 1",
    "Name": "sample string 2",
    "Surnames": "sample string 3",
    "VatIdentifier": "sample string 4",
    "Email": "sample string 5",
    "WebURL": "sample string 6",
    "Phone": "sample string 7",
    "Addressee": "sample string 8",
    "Street": "sample string 9",
    "PostalCode": "sample string 10",
    "Place": {
      "ID": 1,
      "Name": "sample string 2",
      "PostalCode": "sample string 3",
      "LocalityID": 4
    },
    "Country": {
      "ID": 1,
      "Name": "sample string 2",
      "Code": "sample string 3"
    }
  },
  "Items": [
    {
      "ID": 1,
      "InvoiceID": 2,
      "VariationID": 3,
      "Quantity": 4.0,
      "TaxRateID": 5,
      "OriginalPrice": {
        "UnitAmount": 1.0,
        "Discount": 2.0,
        "DiscountPercent": 3.0,
        "UnitBase": 4.0,
        "TaxPercent": 5.0,
        "EquivalenceSurchargePercent": 6.0,
        "Base": 7.0,
        "Tax": 8.0,
        "EquivalenceSurcharge": 9.0,
        "Amount": 10.0
      },
      "Price": {
        "UnitAmount": 1.0,
        "Discount": 2.0,
        "DiscountPercent": 3.0,
        "UnitBase": 4.0,
        "TaxPercent": 5.0,
        "EquivalenceSurchargePercent": 6.0,
        "Base": 7.0,
        "Tax": 8.0,
        "EquivalenceSurcharge": 9.0,
        "Amount": 10.0
      },
      "Observations": "sample string 6"
    },
    {
      "ID": 1,
      "InvoiceID": 2,
      "VariationID": 3,
      "Quantity": 4.0,
      "TaxRateID": 5,
      "OriginalPrice": {
        "UnitAmount": 1.0,
        "Discount": 2.0,
        "DiscountPercent": 3.0,
        "UnitBase": 4.0,
        "TaxPercent": 5.0,
        "EquivalenceSurchargePercent": 6.0,
        "Base": 7.0,
        "Tax": 8.0,
        "EquivalenceSurcharge": 9.0,
        "Amount": 10.0
      },
      "Price": {
        "UnitAmount": 1.0,
        "Discount": 2.0,
        "DiscountPercent": 3.0,
        "UnitBase": 4.0,
        "TaxPercent": 5.0,
        "EquivalenceSurchargePercent": 6.0,
        "Base": 7.0,
        "Tax": 8.0,
        "EquivalenceSurcharge": 9.0,
        "Amount": 10.0
      },
      "Observations": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<Invoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Finance">
  <CustomerContact xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
    <d2p1:Addressee>sample string 8</d2p1:Addressee>
    <d2p1:Country xmlns:d3p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location">
      <d3p1:Code>sample string 3</d3p1:Code>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:Name>sample string 2</d3p1:Name>
    </d2p1:Country>
    <d2p1:Place xmlns:d3p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location">
      <d3p1:ID>1</d3p1:ID>
      <d3p1:LocalityID>4</d3p1:LocalityID>
      <d3p1:Name>sample string 2</d3p1:Name>
      <d3p1:PostalCode>sample string 3</d3p1:PostalCode>
    </d2p1:Place>
    <d2p1:PostalCode>sample string 10</d2p1:PostalCode>
    <d2p1:Street>sample string 9</d2p1:Street>
    <d2p1:Email>sample string 5</d2p1:Email>
    <d2p1:Phone>sample string 7</d2p1:Phone>
    <d2p1:WebURL>sample string 6</d2p1:WebURL>
    <d2p1:Alias>sample string 1</d2p1:Alias>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Surnames>sample string 3</d2p1:Surnames>
    <d2p1:VatIdentifier>sample string 4</d2p1:VatIdentifier>
  </CustomerContact>
  <DueDate>2025-12-06T09:17:18.5706704+01:00</DueDate>
  <ID>1</ID>
  <IssueDate>2025-12-06T09:17:18.5706704+01:00</IssueDate>
  <Items>
    <InvoiceItem>
      <ID>1</ID>
      <InvoiceID>2</InvoiceID>
      <Observations>sample string 6</Observations>
      <OriginalPrice xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
        <d4p1:Amount>10</d4p1:Amount>
        <d4p1:Base>7</d4p1:Base>
        <d4p1:EquivalenceSurcharge>9</d4p1:EquivalenceSurcharge>
        <d4p1:EquivalenceSurchargePercent>6</d4p1:EquivalenceSurchargePercent>
        <d4p1:Tax>8</d4p1:Tax>
        <d4p1:TaxPercent>5</d4p1:TaxPercent>
        <d4p1:Discount>2</d4p1:Discount>
        <d4p1:DiscountPercent>3</d4p1:DiscountPercent>
        <d4p1:UnitAmount>1</d4p1:UnitAmount>
        <d4p1:UnitBase>4</d4p1:UnitBase>
      </OriginalPrice>
      <Price xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
        <d4p1:Amount>10</d4p1:Amount>
        <d4p1:Base>7</d4p1:Base>
        <d4p1:EquivalenceSurcharge>9</d4p1:EquivalenceSurcharge>
        <d4p1:EquivalenceSurchargePercent>6</d4p1:EquivalenceSurchargePercent>
        <d4p1:Tax>8</d4p1:Tax>
        <d4p1:TaxPercent>5</d4p1:TaxPercent>
        <d4p1:Discount>2</d4p1:Discount>
        <d4p1:DiscountPercent>3</d4p1:DiscountPercent>
        <d4p1:UnitAmount>1</d4p1:UnitAmount>
        <d4p1:UnitBase>4</d4p1:UnitBase>
      </Price>
      <Quantity>4</Quantity>
      <TaxRateID>5</TaxRateID>
      <VariationID>3</VariationID>
    </InvoiceItem>
    <InvoiceItem>
      <ID>1</ID>
      <InvoiceID>2</InvoiceID>
      <Observations>sample string 6</Observations>
      <OriginalPrice xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
        <d4p1:Amount>10</d4p1:Amount>
        <d4p1:Base>7</d4p1:Base>
        <d4p1:EquivalenceSurcharge>9</d4p1:EquivalenceSurcharge>
        <d4p1:EquivalenceSurchargePercent>6</d4p1:EquivalenceSurchargePercent>
        <d4p1:Tax>8</d4p1:Tax>
        <d4p1:TaxPercent>5</d4p1:TaxPercent>
        <d4p1:Discount>2</d4p1:Discount>
        <d4p1:DiscountPercent>3</d4p1:DiscountPercent>
        <d4p1:UnitAmount>1</d4p1:UnitAmount>
        <d4p1:UnitBase>4</d4p1:UnitBase>
      </OriginalPrice>
      <Price xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
        <d4p1:Amount>10</d4p1:Amount>
        <d4p1:Base>7</d4p1:Base>
        <d4p1:EquivalenceSurcharge>9</d4p1:EquivalenceSurcharge>
        <d4p1:EquivalenceSurchargePercent>6</d4p1:EquivalenceSurchargePercent>
        <d4p1:Tax>8</d4p1:Tax>
        <d4p1:TaxPercent>5</d4p1:TaxPercent>
        <d4p1:Discount>2</d4p1:Discount>
        <d4p1:DiscountPercent>3</d4p1:DiscountPercent>
        <d4p1:UnitAmount>1</d4p1:UnitAmount>
        <d4p1:UnitBase>4</d4p1:UnitBase>
      </Price>
      <Quantity>4</Quantity>
      <TaxRateID>5</TaxRateID>
      <VariationID>3</VariationID>
    </InvoiceItem>
  </Items>
  <Number>sample string 2</Number>
  <Observations>sample string 5</Observations>
  <PaymentDate>2025-12-06T09:17:18.5706704+01:00</PaymentDate>
  <Price xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">
    <d2p1:Amount>8</d2p1:Amount>
    <d2p1:Base>3</d2p1:Base>
    <d2p1:Discount>6</d2p1:Discount>
    <d2p1:EquivalenceSurcharge>5</d2p1:EquivalenceSurcharge>
    <d2p1:ItemsBase>1</d2p1:ItemsBase>
    <d2p1:ShippingsBase>2</d2p1:ShippingsBase>
    <d2p1:SubTotal>7</d2p1:SubTotal>
    <d2p1:Tax>4</d2p1:Tax>
  </Price>
  <SupplierContact xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
    <d2p1:Addressee>sample string 8</d2p1:Addressee>
    <d2p1:Country xmlns:d3p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location">
      <d3p1:Code>sample string 3</d3p1:Code>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:Name>sample string 2</d3p1:Name>
    </d2p1:Country>
    <d2p1:Place xmlns:d3p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location">
      <d3p1:ID>1</d3p1:ID>
      <d3p1:LocalityID>4</d3p1:LocalityID>
      <d3p1:Name>sample string 2</d3p1:Name>
      <d3p1:PostalCode>sample string 3</d3p1:PostalCode>
    </d2p1:Place>
    <d2p1:PostalCode>sample string 10</d2p1:PostalCode>
    <d2p1:Street>sample string 9</d2p1:Street>
    <d2p1:Email>sample string 5</d2p1:Email>
    <d2p1:Phone>sample string 7</d2p1:Phone>
    <d2p1:WebURL>sample string 6</d2p1:WebURL>
    <d2p1:Alias>sample string 1</d2p1:Alias>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Surnames>sample string 3</d2p1:Surnames>
    <d2p1:VatIdentifier>sample string 4</d2p1:VatIdentifier>
  </SupplierContact>
  <Url>sample string 6</Url>
</Invoice>