GET api/{siteCode}/Accounting/GetValidatedPurchaseInvoices?branchCode={branchCode}
Gets validated purchase invoices and associated costs.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| siteCode |
The site code. |
integer |
Required |
| branchCode |
The branch code. This may be required but is system specific. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
List<InvoiceRecord>.
Collection of InvoiceRecord| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| InvoiceItems | Collection of InvoiceItem |
None. |
|
| InvoiceNumber | string |
None. |
|
| InvoiceDate | date |
None. |
|
| DueDate | date |
None. |
|
| InvoiceType |
Determines whether the document type is an Invoice or Credit |
string |
None. |
| AccountNumber | string |
None. |
|
| AccountName | string |
None. |
|
| CurrencyNet | decimal number |
None. |
|
| BaseCurrencyNet | decimal number |
None. |
|
| CurrencyTax | decimal number |
None. |
|
| BaseCurrencyTax | decimal number |
None. |
|
| CurrencyGross | decimal number |
None. |
|
| BaseCurrencyGross | decimal number |
None. |
|
| InvoiceCurrency | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ID": 1,
"InvoiceItems": [
{
"JobNumber": "sample string 1",
"ItemDescription": "sample string 2",
"NominalAccount": "sample string 3",
"Currency": "sample string 4",
"ExchangeRate": 5.0,
"CurrencyAmount": 6.0,
"BaseAmount": 7.0,
"TaxCode": "sample string 8",
"Taxable": true,
"Comment": "sample string 10",
"ItemType": "sample string 11"
},
{
"JobNumber": "sample string 1",
"ItemDescription": "sample string 2",
"NominalAccount": "sample string 3",
"Currency": "sample string 4",
"ExchangeRate": 5.0,
"CurrencyAmount": 6.0,
"BaseAmount": 7.0,
"TaxCode": "sample string 8",
"Taxable": true,
"Comment": "sample string 10",
"ItemType": "sample string 11"
}
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2025-12-07T07:03:27.3569161+00:00",
"DueDate": "2025-12-07T07:03:27.3569161+00:00",
"InvoiceType": "sample string 4",
"AccountNumber": "sample string 5",
"AccountName": "sample string 6",
"CurrencyNet": 7.0,
"BaseCurrencyNet": 8.0,
"CurrencyTax": 9.0,
"BaseCurrencyTax": 10.0,
"CurrencyGross": 11.0,
"BaseCurrencyGross": 12.0,
"InvoiceCurrency": "sample string 13"
},
{
"ID": 1,
"InvoiceItems": [
{
"JobNumber": "sample string 1",
"ItemDescription": "sample string 2",
"NominalAccount": "sample string 3",
"Currency": "sample string 4",
"ExchangeRate": 5.0,
"CurrencyAmount": 6.0,
"BaseAmount": 7.0,
"TaxCode": "sample string 8",
"Taxable": true,
"Comment": "sample string 10",
"ItemType": "sample string 11"
},
{
"JobNumber": "sample string 1",
"ItemDescription": "sample string 2",
"NominalAccount": "sample string 3",
"Currency": "sample string 4",
"ExchangeRate": 5.0,
"CurrencyAmount": 6.0,
"BaseAmount": 7.0,
"TaxCode": "sample string 8",
"Taxable": true,
"Comment": "sample string 10",
"ItemType": "sample string 11"
}
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2025-12-07T07:03:27.3569161+00:00",
"DueDate": "2025-12-07T07:03:27.3569161+00:00",
"InvoiceType": "sample string 4",
"AccountNumber": "sample string 5",
"AccountName": "sample string 6",
"CurrencyNet": 7.0,
"BaseCurrencyNet": 8.0,
"CurrencyTax": 9.0,
"BaseCurrencyTax": 10.0,
"CurrencyGross": 11.0,
"BaseCurrencyGross": 12.0,
"InvoiceCurrency": "sample string 13"
}
]
application/xml, text/xml
Sample:
<ArrayOfInvoiceRecord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<InvoiceRecord>
<ID>1</ID>
<InvoiceItems>
<InvoiceItem>
<JobNumber>sample string 1</JobNumber>
<ItemDescription>sample string 2</ItemDescription>
<NominalAccount>sample string 3</NominalAccount>
<Currency>sample string 4</Currency>
<ExchangeRate>5</ExchangeRate>
<CurrencyAmount>6</CurrencyAmount>
<BaseAmount>7</BaseAmount>
<TaxCode>sample string 8</TaxCode>
<Taxable>true</Taxable>
<Comment>sample string 10</Comment>
<ItemType>sample string 11</ItemType>
</InvoiceItem>
<InvoiceItem>
<JobNumber>sample string 1</JobNumber>
<ItemDescription>sample string 2</ItemDescription>
<NominalAccount>sample string 3</NominalAccount>
<Currency>sample string 4</Currency>
<ExchangeRate>5</ExchangeRate>
<CurrencyAmount>6</CurrencyAmount>
<BaseAmount>7</BaseAmount>
<TaxCode>sample string 8</TaxCode>
<Taxable>true</Taxable>
<Comment>sample string 10</Comment>
<ItemType>sample string 11</ItemType>
</InvoiceItem>
</InvoiceItems>
<InvoiceNumber>sample string 2</InvoiceNumber>
<InvoiceDate>2025-12-07T07:03:27.3569161+00:00</InvoiceDate>
<DueDate>2025-12-07T07:03:27.3569161+00:00</DueDate>
<InvoiceType>sample string 4</InvoiceType>
<AccountNumber>sample string 5</AccountNumber>
<AccountName>sample string 6</AccountName>
<CurrencyNet>7</CurrencyNet>
<BaseCurrencyNet>8</BaseCurrencyNet>
<CurrencyTax>9</CurrencyTax>
<BaseCurrencyTax>10</BaseCurrencyTax>
<CurrencyGross>11</CurrencyGross>
<BaseCurrencyGross>12</BaseCurrencyGross>
<InvoiceCurrency>sample string 13</InvoiceCurrency>
</InvoiceRecord>
<InvoiceRecord>
<ID>1</ID>
<InvoiceItems>
<InvoiceItem>
<JobNumber>sample string 1</JobNumber>
<ItemDescription>sample string 2</ItemDescription>
<NominalAccount>sample string 3</NominalAccount>
<Currency>sample string 4</Currency>
<ExchangeRate>5</ExchangeRate>
<CurrencyAmount>6</CurrencyAmount>
<BaseAmount>7</BaseAmount>
<TaxCode>sample string 8</TaxCode>
<Taxable>true</Taxable>
<Comment>sample string 10</Comment>
<ItemType>sample string 11</ItemType>
</InvoiceItem>
<InvoiceItem>
<JobNumber>sample string 1</JobNumber>
<ItemDescription>sample string 2</ItemDescription>
<NominalAccount>sample string 3</NominalAccount>
<Currency>sample string 4</Currency>
<ExchangeRate>5</ExchangeRate>
<CurrencyAmount>6</CurrencyAmount>
<BaseAmount>7</BaseAmount>
<TaxCode>sample string 8</TaxCode>
<Taxable>true</Taxable>
<Comment>sample string 10</Comment>
<ItemType>sample string 11</ItemType>
</InvoiceItem>
</InvoiceItems>
<InvoiceNumber>sample string 2</InvoiceNumber>
<InvoiceDate>2025-12-07T07:03:27.3569161+00:00</InvoiceDate>
<DueDate>2025-12-07T07:03:27.3569161+00:00</DueDate>
<InvoiceType>sample string 4</InvoiceType>
<AccountNumber>sample string 5</AccountNumber>
<AccountName>sample string 6</AccountName>
<CurrencyNet>7</CurrencyNet>
<BaseCurrencyNet>8</BaseCurrencyNet>
<CurrencyTax>9</CurrencyTax>
<BaseCurrencyTax>10</BaseCurrencyTax>
<CurrencyGross>11</CurrencyGross>
<BaseCurrencyGross>12</BaseCurrencyGross>
<InvoiceCurrency>sample string 13</InvoiceCurrency>
</InvoiceRecord>
</ArrayOfInvoiceRecord>