GET v1/{organizationId}/tradeoffers?fields={fields}&queryFilter={queryFilter}&changesSince={changesSince}&deletedOnly={deletedOnly}&freeTextSearch={freeTextSearch}&page={page}&pageSize={pageSize}&sort={sort}&sortOrder={sortOrder}

Retrieve a list of trade offers for the organization.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fields

A comma separated list of fields to include in the response. Possible values are: Number, Guid, TimeStamp, ContactName, ContactGuid, Address, Date, Comment, Description, ExternalReference, Language, Currency, TotalExclVat, TotalVatableAmount, TotalInclVat, TotalNonVatableAmount, TotalVat, HasGeneratedAnyVouchers, Status, CreatedAt, UpdatedAt and DeletedAt. If left empty it defaults to guid, contactName, date, description. Note that ProductLines and TotalLines are NOT available when fetching a list. Notice that it's not case sensitive, the property name will be returned the way you request it. If null, defaults to 'guid,contactName,date,description' (notice small start letter).

string

Default value is guid,contactName,date,description

queryFilter

Filter specific for trade offers. Filtering can be applied to following fields: ExternalReference, ContactName, Address, Comment, Description, HasGeneratedAnyVouchers, Currency, Date and Number. See API documentation for filtering format. If left empty no filtering is applied.

string

None.

changesSince

[Generic Filter Option] Only return trade offers that was created, deleted or updated at or after given time. If left empty, this filter will not be applied, and trade offers will be returned regardless of change history. The time must be UTC and in the format 'YYYY-MM-DDTHH:mm:ssZ' example: '2015-08-18T06:36:22Z'.

string

None.

deletedOnly

[Generic Filter Option] Only select deleted trade offers. If left empty, will defaults to false.

boolean

Default value is False

freeTextSearch

A free text search performed on Number, ContactName, Description and TotalInclTax

string

None.

page

The 0-based page number

integer

Default value is 0

pageSize

The maximum number of items to include in a page. Maximum 1000.

integer

Default value is 100

sort

A comma separated list of fields to sort on. Possible values are: TradeOfferNumber, TradeOfferDate, Status and ContactName.

string

Default value is TradeOfferNumber

sortOrder

Valid values are ascending or descending.

string

Default value is descending

organizationId

string

None.

Body Parameters

Response Information

Resource Description

200 (OK) Returns a collection of trade offers (with only the requested fields).

DineroCollectionOfTradeOffer
NameDescriptionType
Collection

Collection containing the result of the request.

Collection of TradeOffer
Pagination

Pagination information.

PaginationDetails
Sample:
{
  "Collection": [
    {
      "HasGeneratedAnyVouchers": true,
      "ContactGuid": "e44c9258-b087-4171-85bc-80c6210dc023",
      "Status": "Invoiced",
      "Guid": "2e5a79bd-3b28-47eb-8ce8-fe847d429777",
      "TimeStamp": "00000000020A5EA8",
      "CreatedAt": "2018-12-19T06:01:36.0757059+00:00",
      "UpdatedAt": "2018-12-19T06:01:36.0757059+00:00",
      "DeletedAt": "2018-12-19T06:01:36.0757059+00:00",
      "Number": 12,
      "ContactName": "Donald Duck",
      "ShowLinesInclVat": false,
      "TotalExclVat": 200.0,
      "TotalVatableAmount": 200.0,
      "TotalInclVat": 250.0,
      "TotalNonVatableAmount": 0.0,
      "TotalVat": 50.0,
      "TotalLines": [
        {
          "Type": "SubTotal",
          "TotalAmount": 200.0,
          "Position": 0,
          "Label": "Subtotal"
        },
        {
          "Type": "SubTotal",
          "TotalAmount": 200.0,
          "Position": 0,
          "Label": "Subtotal"
        }
      ],
      "Currency": "DKK",
      "Language": "en-GB",
      "ExternalReference": "Fx. WebshopSpecialId: 42",
      "Description": "Description of document type. Fx.: invoice, credit note or offer",
      "Comment": "Very very important comment",
      "Date": "2015-12-02",
      "ProductLines": [
        {
          "AccountName": "Bank",
          "BaseAmountValue": 20.0,
          "BaseAmountValueInclVat": 25.0,
          "TotalAmount": 100.0,
          "TotalAmountInclVat": 125.0,
          "ProductGuid": "11c21006-e007-4ad8-902f-aee86e01ba17",
          "Description": "Flowers",
          "Comments": "Smells good",
          "Quantity": 5.0,
          "AccountNumber": 1000,
          "Unit": "parts",
          "Discount": 10.0,
          "LineType": "Product"
        },
        {
          "AccountName": "Bank",
          "BaseAmountValue": 20.0,
          "BaseAmountValueInclVat": 25.0,
          "TotalAmount": 100.0,
          "TotalAmountInclVat": 125.0,
          "ProductGuid": "11c21006-e007-4ad8-902f-aee86e01ba17",
          "Description": "Flowers",
          "Comments": "Smells good",
          "Quantity": 5.0,
          "AccountNumber": 1000,
          "Unit": "parts",
          "Discount": 10.0,
          "LineType": "Product"
        }
      ],
      "Address": "Test Road 3 2100 Copenhagen Denmark"
    },
    {
      "HasGeneratedAnyVouchers": true,
      "ContactGuid": "e44c9258-b087-4171-85bc-80c6210dc023",
      "Status": "Invoiced",
      "Guid": "2e5a79bd-3b28-47eb-8ce8-fe847d429777",
      "TimeStamp": "00000000020A5EA8",
      "CreatedAt": "2018-12-19T06:01:36.0757059+00:00",
      "UpdatedAt": "2018-12-19T06:01:36.0757059+00:00",
      "DeletedAt": "2018-12-19T06:01:36.0757059+00:00",
      "Number": 12,
      "ContactName": "Donald Duck",
      "ShowLinesInclVat": false,
      "TotalExclVat": 200.0,
      "TotalVatableAmount": 200.0,
      "TotalInclVat": 250.0,
      "TotalNonVatableAmount": 0.0,
      "TotalVat": 50.0,
      "TotalLines": [
        {
          "Type": "SubTotal",
          "TotalAmount": 200.0,
          "Position": 0,
          "Label": "Subtotal"
        },
        {
          "Type": "SubTotal",
          "TotalAmount": 200.0,
          "Position": 0,
          "Label": "Subtotal"
        }
      ],
      "Currency": "DKK",
      "Language": "en-GB",
      "ExternalReference": "Fx. WebshopSpecialId: 42",
      "Description": "Description of document type. Fx.: invoice, credit note or offer",
      "Comment": "Very very important comment",
      "Date": "2015-12-02",
      "ProductLines": [
        {
          "AccountName": "Bank",
          "BaseAmountValue": 20.0,
          "BaseAmountValueInclVat": 25.0,
          "TotalAmount": 100.0,
          "TotalAmountInclVat": 125.0,
          "ProductGuid": "11c21006-e007-4ad8-902f-aee86e01ba17",
          "Description": "Flowers",
          "Comments": "Smells good",
          "Quantity": 5.0,
          "AccountNumber": 1000,
          "Unit": "parts",
          "Discount": 10.0,
          "LineType": "Product"
        },
        {
          "AccountName": "Bank",
          "BaseAmountValue": 20.0,
          "BaseAmountValueInclVat": 25.0,
          "TotalAmount": 100.0,
          "TotalAmountInclVat": 125.0,
          "ProductGuid": "11c21006-e007-4ad8-902f-aee86e01ba17",
          "Description": "Flowers",
          "Comments": "Smells good",
          "Quantity": 5.0,
          "AccountNumber": 1000,
          "Unit": "parts",
          "Discount": 10.0,
          "LineType": "Product"
        }
      ],
      "Address": "Test Road 3 2100 Copenhagen Denmark"
    }
  ],
  "Pagination": {
    "MaxPageSizeAllowed": 0,
    "PageSize": 0,
    "Result": 0,
    "ResultWithoutFilter": 0,
    "Page": 0
  }
}