List credit notes

Retrieve a list of credit notes for the organization.

Query parameters

NameDescription
startDate string

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.

endDate string

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.

fields string

A comma separated list of fields to include in the response. Possible values are: 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.

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

freeTextSearch string

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

statusFilter string

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.

queryFilter string

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

changesSince string

[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'.

deletedOnly boolean

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

Default value is False

page integer

The 0-based page number

Default value is 0

pageSize integer

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

Default value is 100

sort string

A comma separated list of fields to sort on. Possible values are: VoucherNumber, VoucherDate, Status and Contact.

Default value is VoucherNumber,VoucherDate

sortOrder string

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

Default value is descending

organizationId string

Returns

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

NameDescription
Collection SalesVoucherReadListModel[] Show model
NameDescription
Number integer

The number of the voucher.

Guid globally unique identifier

The guid of the voucher

ExternalReference string

Gets or sets the external id - this can be used for id'ing in external apps/services. Like some id string in a web shop The maximum length is 128 characters

Date string

The date of the creation/issuing. This should be in the format YYYY-MM-DD e.g. 2015-12-02. Defaults to today.

PaymentDate string

The invoice's payment date. This should be in the format YYYY-MM-DD e.g. 2015-12-02. It's null on credit notes.

Description string

User supplied description of the voucher e.g. 'Custom Invoice description'. Defaults to document type e.g. 'Invoice', 'Offer', 'Creditnote' using the selected language.

Status string

An sales voucher can have status Draft, Booked, Paid, OverPaid or Overdue

Type string

An sales voucher can have two types, Invoice or CreditNote

ContactName string

Contact name

ContactGuid globally unique identifier

Guid of the contact

TotalInclVat decimal number

Total amount incl. VAT

TotalExclVat decimal number

Total amount excl. VAT

TotalInclVatInDkk decimal number

Total amount incl. VAT in DKK

TotalExclVatInDkk decimal number

Total amount excl. VAT in DKK

MailOutStatus string

The voucher can have following status: NotSent, Sent or SeenByCustomer. SeenByCustomer, means the user has clicked on the link in the mailout and viewed the sales voucher. Any type of mailout (email, reminder, pre-reminder, e-invoice), will change the status from NotSent to Sent.

Currency string

Currencies are given i format: DKK, EUR, USD ect...

CreatedAt date

Time of creation

UpdatedAt date

Time of last update

DeletedAt date

Time of deletion. Null unless the object is deleted.

Collection containing the result of the request.

Pagination PaginationDetails Show model
NameDescription
MaxPageSizeAllowed integer

Maximum number of result pr. page.

PageSize integer

Number of result pr. page.

Result integer

Number of results returned in the collection.

ResultWithoutFilter integer

Result count before pagination.

Page integer

The 0-based page number.

Pagination information.

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

Response Formats

{
  "Collection": [
    {
      "Guid": "9ba58829-48f0-4182-b078-5d32aa151e52",
      "Number": 12,
      "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-07-23T09:17:43.6445741Z",
      "UpdatedAt": "2019-07-23T09:17:43.6445741Z",
      "DeletedAt": "2019-07-23T09:17:43.6445741Z"
    },
    {
      "Guid": "9ba58829-48f0-4182-b078-5d32aa151e52",
      "Number": 12,
      "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-07-23T09:17:43.6445741Z",
      "UpdatedAt": "2019-07-23T09:17:43.6445741Z",
      "DeletedAt": "2019-07-23T09:17:43.6445741Z"
    }
  ],
  "Pagination": {
    "MaxPageSizeAllowed": 0,
    "PageSize": 0,
    "Result": 0,
    "ResultWithoutFilter": 0,
    "Page": 0
  }
}