GET Integrations/CSV/V1/GetCreditNotes

Returns the credit notes export data

Request Information

URI Parameters

Name	Type	Description	Additional information
SiteIDs	Collection of integer	List of Site IDs to get export data for	None.
StartDate	date	Start time range for the export	None.
EndDate	date	End time range for the export	None.
StockLocationID	integer	Stock Location ID filter	None.
SupplierCode	string	Supplier Code filter	None.
SupplierID	integer	Supplier ID filter	None.

Body Parameters

CSVExportRequestCommand

Name	Type	Description	Additional information
SiteIDs	Collection of integer	List of Site IDs to get export data for	None.
StartDate	date	Start time range for the export	None.
EndDate	date	End time range for the export	None.
StockLocationID	integer	Stock Location ID filter	None.
SupplierCode	string	Supplier Code filter	None.
SupplierID	integer	Supplier ID filter	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteIDs": [
    1,
    2
  ],
  "StartDate": "2025-03-31T22:33:51.3226413+01:00",
  "EndDate": "2025-03-31T22:33:51.3226413+01:00",
  "StockLocationID": 3,
  "SupplierCode": "sample string 4",
  "SupplierID": 5
}

application/xml, text/xml

Sample:

<CSVExportRequestCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.App.Models">
  <EndDate>2025-03-31T22:33:51.3226413+01:00</EndDate>
  <SiteIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SiteIDs>
  <StartDate>2025-03-31T22:33:51.3226413+01:00</StartDate>
  <StockLocationID>3</StockLocationID>
  <SupplierCode>sample string 4</SupplierCode>
  <SupplierID>5</SupplierID>
</CSVExportRequestCommand>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of CreditNoteExportLineDto

Name	Type	Additional information
Site	string	None.
CreditNoteID	integer	None.
Reference	string	None.
CompanyCode	string	None.
SupplierID	integer	None.
SupplierCode	string	None.
CreditDateUtc	date	None.
CurrencyCode	string	None.
Description	string	None.
AccountCode	string	None.
CostCentreCode	string	None.
Quantity	decimal number	None.
UnitNetCost	decimal number	None.
UnitVATAmount	decimal number	None.
VATCode	string	None.
AcceptanceDateUtc	date	None.
ApprovalDateUtc	date	None.
CompleteDateUtc	date	None.
LastModifiedUtc	date	None.
LastModifiedBy	string	None.
ProductTypeID	integer	None.
ProductTypeName	string	None.
ProductGroupID	integer	None.
ProductGroupName	string	None.
StockLocationID	integer	None.
StockLocationName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Site": "sample string 1",
    "CreditNoteID": 2,
    "Reference": "sample string 3",
    "CompanyCode": "sample string 4",
    "SupplierID": 5,
    "SupplierCode": "sample string 6",
    "CreditDateUtc": "2025-03-31T22:33:51.3226413+01:00",
    "CurrencyCode": "sample string 7",
    "Description": "sample string 8",
    "AccountCode": "sample string 9",
    "CostCentreCode": "sample string 10",
    "Quantity": 11.0,
    "UnitNetCost": 12.0,
    "UnitVATAmount": 13.0,
    "VATCode": "sample string 14",
    "AcceptanceDateUtc": "2025-03-31T22:33:51.3226413+01:00",
    "ApprovalDateUtc": "2025-03-31T22:33:51.3226413+01:00",
    "CompleteDateUtc": "2025-03-31T22:33:51.3226413+01:00",
    "LastModifiedUtc": "2025-03-31T22:33:51.3226413+01:00",
    "LastModifiedBy": "sample string 15",
    "ProductTypeID": 16,
    "ProductTypeName": "sample string 17",
    "ProductGroupID": 18,
    "ProductGroupName": "sample string 19",
    "StockLocationID": 20,
    "StockLocationName": "sample string 21"
  },
  {
    "Site": "sample string 1",
    "CreditNoteID": 2,
    "Reference": "sample string 3",
    "CompanyCode": "sample string 4",
    "SupplierID": 5,
    "SupplierCode": "sample string 6",
    "CreditDateUtc": "2025-03-31T22:33:51.3226413+01:00",
    "CurrencyCode": "sample string 7",
    "Description": "sample string 8",
    "AccountCode": "sample string 9",
    "CostCentreCode": "sample string 10",
    "Quantity": 11.0,
    "UnitNetCost": 12.0,
    "UnitVATAmount": 13.0,
    "VATCode": "sample string 14",
    "AcceptanceDateUtc": "2025-03-31T22:33:51.3226413+01:00",
    "ApprovalDateUtc": "2025-03-31T22:33:51.3226413+01:00",
    "CompleteDateUtc": "2025-03-31T22:33:51.3226413+01:00",
    "LastModifiedUtc": "2025-03-31T22:33:51.3226413+01:00",
    "LastModifiedBy": "sample string 15",
    "ProductTypeID": 16,
    "ProductTypeName": "sample string 17",
    "ProductGroupID": 18,
    "ProductGroupName": "sample string 19",
    "StockLocationID": 20,
    "StockLocationName": "sample string 21"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCreditNoteExportLineDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.Integrations.Csv.Models.Dto">
  <CreditNoteExportLineDto>
    <AcceptanceDateUtc>2025-03-31T22:33:51.3226413+01:00</AcceptanceDateUtc>
    <AccountCode>sample string 9</AccountCode>
    <ApprovalDateUtc>2025-03-31T22:33:51.3226413+01:00</ApprovalDateUtc>
    <CompanyCode>sample string 4</CompanyCode>
    <CompleteDateUtc>2025-03-31T22:33:51.3226413+01:00</CompleteDateUtc>
    <CostCentreCode>sample string 10</CostCentreCode>
    <CreditDateUtc>2025-03-31T22:33:51.3226413+01:00</CreditDateUtc>
    <CreditNoteID>2</CreditNoteID>
    <CurrencyCode>sample string 7</CurrencyCode>
    <Description>sample string 8</Description>
    <LastModifiedBy>sample string 15</LastModifiedBy>
    <LastModifiedUtc>2025-03-31T22:33:51.3226413+01:00</LastModifiedUtc>
    <ProductGroupID>18</ProductGroupID>
    <ProductGroupName>sample string 19</ProductGroupName>
    <ProductTypeID>16</ProductTypeID>
    <ProductTypeName>sample string 17</ProductTypeName>
    <Quantity>11</Quantity>
    <Reference>sample string 3</Reference>
    <Site>sample string 1</Site>
    <StockLocationID>20</StockLocationID>
    <StockLocationName>sample string 21</StockLocationName>
    <SupplierCode>sample string 6</SupplierCode>
    <SupplierID>5</SupplierID>
    <UnitNetCost>12</UnitNetCost>
    <UnitVATAmount>13</UnitVATAmount>
    <VATCode>sample string 14</VATCode>
  </CreditNoteExportLineDto>
  <CreditNoteExportLineDto>
    <AcceptanceDateUtc>2025-03-31T22:33:51.3226413+01:00</AcceptanceDateUtc>
    <AccountCode>sample string 9</AccountCode>
    <ApprovalDateUtc>2025-03-31T22:33:51.3226413+01:00</ApprovalDateUtc>
    <CompanyCode>sample string 4</CompanyCode>
    <CompleteDateUtc>2025-03-31T22:33:51.3226413+01:00</CompleteDateUtc>
    <CostCentreCode>sample string 10</CostCentreCode>
    <CreditDateUtc>2025-03-31T22:33:51.3226413+01:00</CreditDateUtc>
    <CreditNoteID>2</CreditNoteID>
    <CurrencyCode>sample string 7</CurrencyCode>
    <Description>sample string 8</Description>
    <LastModifiedBy>sample string 15</LastModifiedBy>
    <LastModifiedUtc>2025-03-31T22:33:51.3226413+01:00</LastModifiedUtc>
    <ProductGroupID>18</ProductGroupID>
    <ProductGroupName>sample string 19</ProductGroupName>
    <ProductTypeID>16</ProductTypeID>
    <ProductTypeName>sample string 17</ProductTypeName>
    <Quantity>11</Quantity>
    <Reference>sample string 3</Reference>
    <Site>sample string 1</Site>
    <StockLocationID>20</StockLocationID>
    <StockLocationName>sample string 21</StockLocationName>
    <SupplierCode>sample string 6</SupplierCode>
    <SupplierID>5</SupplierID>
    <UnitNetCost>12</UnitNetCost>
    <UnitVATAmount>13</UnitVATAmount>
    <VATCode>sample string 14</VATCode>
  </CreditNoteExportLineDto>
</ArrayOfCreditNoteExportLineDto>