GET v1/{organizationId}/sales?startDate={startDate}&endDate={endDate}&fields={fields}&freeTextSearch={freeTextSearch}&statusFilter={statusFilter}&queryFilter={queryFilter}&changesSince={changesSince}&deletedOnly={deletedOnly}&page={page}&pageSize={pageSize}&sort={sort}&sortOrder={sortOrder}

Retrieve a list of invoices and credit notes for the organization.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
startDate

Start date in format 'YYYY-MM-DD' example '2015-01-01'. If you define a start date, you also need to define an end date.

string

None.

endDate

End date in format 'YYYY-MM-DD' example '2015-01-01'. If you define an end date, you also need to define a start date.

string

None.

fields

A comma separated list of fields to include in the response. Possible values are: Type, Number, Guid, ExternalReference, ContactName, ContactGuid, Date, PaymentDate, Description, Currency, Status, MailOutStatus, TotalExclVatInDkk, TotalInclVatInDkk, TotalExclVat, TotalInclVat, CreatedAt, UpdatedAt and DeletedAt. If null, defaults to Guid,ContactName,Date,Description,Type. Notice that it's not case sensitive, the property name will be returned the way you request it.

string

Default value is Guid,ContactName,Date,Description,Type

freeTextSearch

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

string

None.

statusFilter

Filter on Status. You can choose Draft, Booked, Paid, OverPaid or Overdue. You can add multible filters example: 'Paid,OverPaid,Overdue'. If left empty no filter is applied.

string

None.

queryFilter

Filtering can be applied to following fields: ExternalReference, ContactGuid, Description. See API documentation for filtering format. If left empty no filtering is applied.

string

None.

changesSince

[Generic Filter Option] Only return credit notes that was created, deleted or updated at or after given time. If left empty, this filter will not be applied, and credit notes 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 credit notes. If left empty, will defaults to false.

boolean

Default value is False

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: VoucherNumber, VoucherDate, Status and Contact.

string

Default value is VoucherNumber,VoucherDate

sortOrder

Sort order. Valid values are ascending and descending. Field Status is always sorted in the order Draft, Overdue, Booked, OverPaid and Paid.

string

Default value is descending

organizationId

string

None.

Body Parameters

Response Information

Resource Description

200 (OK) Returns a collection of credit notes (with only the requested fields).

DineroCollectionOfSalesVoucherReadListModel
NameDescriptionType
Collection

Collection containing the result of the request.

Collection of SalesVoucherReadListModel
Pagination

Pagination information.

PaginationDetails
Sample:
{
  "Collection": [
    {
      "Number": 12,
      "Guid": "e9a514b3-38bd-4819-9891-6b5d0d4cb391",
      "ExternalReference": "yourReference",
      "Date": "2015-12-02",
      "PaymentDate": "2015-12-02",
      "Description": "Description of document type. Fx.: invoice, credit note or offer",
      "Status": "Draft",
      "Type": "Invoice",
      "ContactName": "Donald Duck",
      "ContactGuid": null,
      "TotalInclVat": 250.0,
      "TotalExclVat": 200.0,
      "TotalInclVatInDkk": 1850.0,
      "TotalExclVatInDkk": 1500.0,
      "MailOutStatus": "Sent",
      "Currency": "EUR",
      "CreatedAt": "2019-01-16T18:30:51.0534848+00:00",
      "UpdatedAt": "2019-01-16T18:30:51.0534848+00:00",
      "DeletedAt": "2019-01-16T18:30:51.0534848+00:00"
    },
    {
      "Number": 12,
      "Guid": "e9a514b3-38bd-4819-9891-6b5d0d4cb391",
      "ExternalReference": "yourReference",
      "Date": "2015-12-02",
      "PaymentDate": "2015-12-02",
      "Description": "Description of document type. Fx.: invoice, credit note or offer",
      "Status": "Draft",
      "Type": "Invoice",
      "ContactName": "Donald Duck",
      "ContactGuid": null,
      "TotalInclVat": 250.0,
      "TotalExclVat": 200.0,
      "TotalInclVatInDkk": 1850.0,
      "TotalExclVatInDkk": 1500.0,
      "MailOutStatus": "Sent",
      "Currency": "EUR",
      "CreatedAt": "2019-01-16T18:30:51.0534848+00:00",
      "UpdatedAt": "2019-01-16T18:30:51.0534848+00:00",
      "DeletedAt": "2019-01-16T18:30:51.0534848+00:00"
    }
  ],
  "Pagination": {
    "MaxPageSizeAllowed": 0,
    "PageSize": 0,
    "Result": 0,
    "ResultWithoutFilter": 0,
    "Page": 0
  }
}