Get list of credit notes

get https://api.reepay.com/v1/list/credit_note

Get list of credit notes. See List queries for a general introduction to list operations. Note that excessive usage will be considered unfair API usage.

Examples

Get all credit notes for a customer cust-007.

GET https://api.reepay.com/v1/list/credit_note?customer=cust-007

Get settled invoices for January 2022 with amount 20000 in DKK

GET https://api.reepay.com/v1/list/credit_note?amount=[20000;20000]&currency=DKK&from=2022-01-01&to=2022-02-01

Query Params

from

string

Time range from (inclusive). Local date and time (according to account timezone) on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS. Default from if no interval is given depends on the query. If the query limits on relation e.g. customer and/or subscription, the default from will be epoch 1970-01-01, otherwise one month before to

string

Time range to (exclusive). Local date and time (according to account timezone) on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS. Defaults to now.

interval

string

Limit from to and interval back in time. E.g. one week. Will take precedence over from. Defined in ISO 8601 duration. See https://en.wikipedia.org/wiki/ISO_8601#Durations

size

int32

10 to 100

Defaults to 20

Page size between 10 and 100 (default 20)

next_page_token

string

Next page token from previous response to get next page

accounting_number

string

Credit note exact accounting number

accounting_number_prefix

string

Credit note accounting number prefix

accounting_number_contains

string

Credit note accounting number contains

amount

string

Amount in minor unit interval. See documentation of intervals.

customer

string

Credit notes for customer by customer handle

currency

array of strings

Credit note currency in ISO 4217 three letter alpha code. Multiple can be defined.

currency

subscription

string

Credit note for subscription by subscription handle

invoice

string

Credit note for invoice by invoice handle

debtor_id

string

Credit notes for customer by debtor id

Responses

Response body

object

size

int32

required

10 to 100

Page size used in paginated list

count

int32

required

≥ 0

Number of elements in current page. If less than page size it is the last page.

string

required

Local date and time range used as to (exclusive)

from

string

required

Local date and time range used as from (inclusive)

content

array of objects

required

List of credit notes for current page

content*

object

string

required

length ≥ 1

Credit note id

invoice

string

required

Invoice credited by this note

transaction

string

Refund transaction id if credit note has an associated refund

credit

string

Credit reference if the credit note relates to a subscription credit

amount

int32

required

Credit note amount

created

date-time

required

Creation date for note, in ISO-8601 extended offset date-time format.

currency

string

required

Credit note currency in ISO 4217 three letter alpha code

customer

string

required

length ≥ 1

Customer handle

subscription

string

Subscription handle, will be null for a one-time customer invoice

credits

array of objects

required

Credits applied to credit note

credits*

object

credit

string

required

length ≥ 1

Credit handle

amount

int32

required

≥ 0

The credit amount transferred to invoice

created

date-time

required

Date when credit was transferred to invoice. In ISO-8601 extended offset date-time format.

text

string

required

length ≥ 1

Text describing the credit.

amount_vat

int32

required

Credit note vat amount calculated as rounded summed fractional vats for each credit note lines

amount_ex_vat

int32

Credit note total amount excluding VAT calculated as summed amounts excl. vats for each credit note lines

credit_note_lines

array of objects

required

Credit note lines

credit_note_lines*

object

amount

int32

required

≥ 1

Credit note line total amount

text

string

required

length ≥ 1

Credit note line text

description

string

Order line description

quantity

int32

required

≥ 1

Credit note line quantity

vat

float

Vat for this credit note line

created

date-time

Creation date for this credit note line, in ISO-8601 extended offset date-time format.

origin

string

Order line origin, one of the following: plan, add_on, ondemand, additional_cost, credit, discount, setup_fee, surcharge_fee, metered_billing_product

plan add_on ondemand additional_cost credit discount setup_fee surcharge_fee metered_billing_product

order_line_id

string

Reference to invoice orderline this credit note line relates to

amount_incl_vat

int32

Credit note line total amount including VAT

amount_ex_vat

int32

Credit note line total amount excluding VAT

unit_amount

int32

Credit note line unit amount

unit_amount_vat

int32

Credit note line vat amount

unit_amount_ex_vat

int32

Credit note line unit amount excluding VAT

amount_incl_vat_defined

boolean

Whether the total and units are including VAT.

period_from

date-time

The start of billing period in ISO-8601 extended offset date-time format.

period_to

date-time

The end of billing period in ISO-8601 extended offset date-time format.

accounting_number

string

Credit note accounting number

debtor_id

int64

Customer debtor id

download_url

string

Url to credit note pdf

accounting_created_date

date-time

When the credit note was created. A credit note is created when a non-charging invoice is cancelled or refunded. Timestamp in ISO-8601 extended offset date-time format.

payable_amount

int32

The credit note amount to be payed including VAT

amount_vat_lines

array of objects

The list of VAT amounts grouped by VAT percentage

amount_vat_lines

object

vat

float

required

Vat percent

amount_vat

int32

required

Total vat amount

range

string

required

Time and date attribute used to time limit. Only created could be present.

created

next_page_token

string

Pagination token to use to get the next page. Notice that page size and range should be the same for all page requests. If not present the last page has been reached.

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.reepay.com/v1/list/credit_note \
3
     --header 'accept: application/json'


xxxxxxxxxx
62
}
1
{
2
  "size": 50,
3
  "count": 50,
4
  "to": "2021-10-06T13:02:23.190",
5
  "from": "2021-09-06T13:02:23.190",
6
  "content": [
7
    {
8
      "id": "c33fbb06a00e4dc0b9055f6fb509c0ed",
9
      "invoice": "inv-2021",
10
      "transaction": "082ebeb1b5864e019b6bf13cad7c535b",
11
      "credit": "credit-234",
12
      "amount": 15000,
13
      "created": "2015-04-04T12:40:56.656Z",
14
      "currency": "DKK",
15
      "customer": "customer006",
16
      "subscription": "sub010",
17
      "credits": [
18
        {
19
          "credit": "credit002",
20
          "amount": 10000,
21
          "created": "2015-04-04T12:40:56.656Z",
22
          "text": "Credit for lower bandwidth"
23
        }
24
      ],
25
      "amount_vat": 2000,

Examples

200Successful operation

400Invalid request, see error codes at https://api.reepay.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.reepay.com/v1/error_codes

429Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123

500Internal service error, error is reported automatically to Frisbii