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.

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.

Request Formats

application/json, text/json

Sample:

{
  "SiteIDs": [
    1,
    2
  ],
  "StartDate": "2024-11-21T06:26:15.0935654+00:00",
  "EndDate": "2024-11-21T06:26:15.0935654+00:00"
}

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>2024-11-21T06:26:15.0935654+00: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>2024-11-21T06:26:15.0935654+00:00</StartDate>
</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.
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.

Response Formats

application/json, text/json

Sample:

[
  {
    "Site": "sample string 1",
    "CreditNoteID": 2,
    "Reference": "sample string 3",
    "CompanyCode": "sample string 4",
    "SupplierCode": "sample string 5",
    "CreditDateUtc": "2024-11-21T06:26:15.0935654+00:00",
    "CurrencyCode": "sample string 6",
    "Description": "sample string 7",
    "AccountCode": "sample string 8",
    "CostCentreCode": "sample string 9",
    "Quantity": 10.0,
    "UnitNetCost": 11.0,
    "UnitVATAmount": 12.0,
    "VATCode": "sample string 13",
    "AcceptanceDateUtc": "2024-11-21T06:26:15.0935654+00:00",
    "ApprovalDateUtc": "2024-11-21T06:26:15.0935654+00:00",
    "CompleteDateUtc": "2024-11-21T06:26:15.0935654+00:00",
    "LastModifiedUtc": "2024-11-21T06:26:15.0935654+00:00",
    "LastModifiedBy": "sample string 14"
  },
  {
    "Site": "sample string 1",
    "CreditNoteID": 2,
    "Reference": "sample string 3",
    "CompanyCode": "sample string 4",
    "SupplierCode": "sample string 5",
    "CreditDateUtc": "2024-11-21T06:26:15.0935654+00:00",
    "CurrencyCode": "sample string 6",
    "Description": "sample string 7",
    "AccountCode": "sample string 8",
    "CostCentreCode": "sample string 9",
    "Quantity": 10.0,
    "UnitNetCost": 11.0,
    "UnitVATAmount": 12.0,
    "VATCode": "sample string 13",
    "AcceptanceDateUtc": "2024-11-21T06:26:15.0935654+00:00",
    "ApprovalDateUtc": "2024-11-21T06:26:15.0935654+00:00",
    "CompleteDateUtc": "2024-11-21T06:26:15.0935654+00:00",
    "LastModifiedUtc": "2024-11-21T06:26:15.0935654+00:00",
    "LastModifiedBy": "sample string 14"
  }
]

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>2024-11-21T06:26:15.0935654+00:00</AcceptanceDateUtc>
    <AccountCode>sample string 8</AccountCode>
    <ApprovalDateUtc>2024-11-21T06:26:15.0935654+00:00</ApprovalDateUtc>
    <CompanyCode>sample string 4</CompanyCode>
    <CompleteDateUtc>2024-11-21T06:26:15.0935654+00:00</CompleteDateUtc>
    <CostCentreCode>sample string 9</CostCentreCode>
    <CreditDateUtc>2024-11-21T06:26:15.0935654+00:00</CreditDateUtc>
    <CreditNoteID>2</CreditNoteID>
    <CurrencyCode>sample string 6</CurrencyCode>
    <Description>sample string 7</Description>
    <LastModifiedBy>sample string 14</LastModifiedBy>
    <LastModifiedUtc>2024-11-21T06:26:15.0935654+00:00</LastModifiedUtc>
    <Quantity>10</Quantity>
    <Reference>sample string 3</Reference>
    <Site>sample string 1</Site>
    <SupplierCode>sample string 5</SupplierCode>
    <UnitNetCost>11</UnitNetCost>
    <UnitVATAmount>12</UnitVATAmount>
    <VATCode>sample string 13</VATCode>
  </CreditNoteExportLineDto>
  <CreditNoteExportLineDto>
    <AcceptanceDateUtc>2024-11-21T06:26:15.0935654+00:00</AcceptanceDateUtc>
    <AccountCode>sample string 8</AccountCode>
    <ApprovalDateUtc>2024-11-21T06:26:15.0935654+00:00</ApprovalDateUtc>
    <CompanyCode>sample string 4</CompanyCode>
    <CompleteDateUtc>2024-11-21T06:26:15.0935654+00:00</CompleteDateUtc>
    <CostCentreCode>sample string 9</CostCentreCode>
    <CreditDateUtc>2024-11-21T06:26:15.0935654+00:00</CreditDateUtc>
    <CreditNoteID>2</CreditNoteID>
    <CurrencyCode>sample string 6</CurrencyCode>
    <Description>sample string 7</Description>
    <LastModifiedBy>sample string 14</LastModifiedBy>
    <LastModifiedUtc>2024-11-21T06:26:15.0935654+00:00</LastModifiedUtc>
    <Quantity>10</Quantity>
    <Reference>sample string 3</Reference>
    <Site>sample string 1</Site>
    <SupplierCode>sample string 5</SupplierCode>
    <UnitNetCost>11</UnitNetCost>
    <UnitVATAmount>12</UnitVATAmount>
    <VATCode>sample string 13</VATCode>
  </CreditNoteExportLineDto>
</ArrayOfCreditNoteExportLineDto>