invoice

GET /v3/invoice

Get list of invoices

Request

  • Base URL
    https://customer-portal-api.frisbii.com
  • URL
    https://customer-portal-api.frisbii.com/v3/invoice
  • Auth
    none declared

Query parameters

fromstring

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

Example:2019-12-01
tostring

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.

Example:2020-01-01
intervalstring

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

Example:P1W
sizeinteger

Page size between 10 and 100 (default 20)

Example:10
next_page_tokenstring

Next page token from previous response to get next page

Example:MTYzMjkxNDc4NTAwMDoxMA

Response

Successful operation

sizeinteger required

Page size used in paginated list

countinteger required

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

tostring required

Local date and time range used as to (exclusive)

fromstring required

Local date and time range used as from (inclusive)

next_page_tokenstring

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.

Example response

{
  "size": 50,
  "count": 50,
  "to": "2021-10-06T13:02:23.190",
  "from": "2021-09-06T13:02:23.190",
  "content": [
    {
      "handle": "inv-311",
      "state": "pending",
      "amount": 10000,
      "currency": "DKK",
      "created": "2015-04-04T12:40:56.656Z",
      "type": "pending",
      "transactions": [
        {
          "id": "dafba2016614418f969fa5697383e47c",
          "state": "settled",
          "invoice": "order-1234",
          "type": "settle",
          "amount": 10000,
          "currency": "DKK",
          "settled": "2015-04-04T12:40:56.656Z",
          "failed": "2015-04-04T12:40:56.656Z",
          "refunded": "2015-04-04T12:40:56.656Z",
          "created": "2015-04-04T12:40:56.656Z",
          "payment_type": "card",
          "payment_method": "sr_4f3b975246e6acb7f569297d67830d64",
          "card_transaction": {
            "card": {
              "id": "ca_fcfac2016614418f969fa5697383e47c",
              "state": "active",
              "customer": "customer00069",
              "reference": "cs_6be90a4babc3c57ef7e6e477ac97ed3b",
              "failed": "2015-06-04T12:40:56.656Z",
              "created": "2015-04-04T12:40:56.656Z",
              "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
              "reactivated": "2015-05-14T00:00:00Z",
              "gw_ref": "657e86162633415a9e6b715248c84da4",
              "card_type": "visa_dk",
              "transaction_card_type": "visa",
              "exp_date": "09-18",
              "masked_card": "457111XXXXXX3777",
              "last_success": "2015-05-14T00:00:00Z",
              "last_failed": "2015-05-14T00:00:00Z",
              "first_fail": "2015-05-14T00:00:00Z",
              "error_code": "credit_card_expired",
              "error_state": "hard_declined",
              "strong_authentication_status": "secured_by_nets",
              "three_d_secure_status": "Y",
              "card_country": "US"
            },
            "error": "credit_card_expired",
            "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
            "provider": "clearhaus",
            "frictionless": true,
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "gw_id": "28fc559a229e4fd3a134297a478a0075",
            "last_failed": "2015-04-04T12:40:56.656Z",
            "first_failed": "2015-04-04T12:40:56.656Z",
            "error_state": "hard_declined",
            "card_type": "visa_dk",
            "transaction_card_type": "visa",
            "exp_date": "09-18",
            "masked_card": "457111XXXXXX3777",
            "card_country": "US",
            "strong_authentication_status": "secured_by_nets",
            "three_d_secure_status": "Y",
            "acquirer_code": "40135",
            "acquirer_message": "Card expired",
            "acquirer_reference": "Card expired",
            "text_on_statement": "myshop.com 123",
            "surcharge_fee": 123,
            "cardholder_name": "Jane Doe"
          },
          "mpo_transaction": {
            "card": {
              "id": "ca_fcfac2016614418f969fa5697383e47c",
              "state": "active",
              "customer": "customer00069",
              "reference": "cs_6be90a4babc3c57ef7e6e477ac97ed3b",
              "failed": "2015-06-04T12:40:56.656Z",
              "created": "2015-04-04T12:40:56.656Z",
              "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
              "reactivated": "2015-05-14T00:00:00Z",
              "gw_ref": "657e86162633415a9e6b715248c84da4",
              "card_type": "visa_dk",
              "transaction_card_type": "visa",
              "exp_date": "09-18",
              "masked_card": "457111XXXXXX3777",
              "last_success": "2015-05-14T00:00:00Z",
              "last_failed": "2015-05-14T00:00:00Z",
              "first_fail": "2015-05-14T00:00:00Z",
              "error_code": "credit_card_expired",
              "error_state": "hard_declined",
              "strong_authentication_status": "secured_by_nets",
              "three_d_secure_status": "Y",
              "card_country": "US"
            },
            "error": "credit_card_expired",
            "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
            "provider": "clearhaus",
            "frictionless": true,
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "gw_id": "28fc559a229e4fd3a134297a478a0075",
            "last_failed": "2015-04-04T12:40:56.656Z",
            "first_failed": "2015-04-04T12:40:56.656Z",
            "error_state": "hard_declined",
            "card_type": "visa_dk",
            "transaction_card_type": "visa",
            "exp_date": "09-18",
            "masked_card": "457111XXXXXX3777",
            "card_country": "US",
            "strong_authentication_status": "secured_by_nets",
            "three_d_secure_status": "Y",
            "acquirer_code": "40135",
            "acquirer_message": "Card expired",
            "acquirer_reference": "Card expired",
            "text_on_statement": "myshop.com 123",
            "surcharge_fee": 123,
            "cardholder_name": "Jane Doe"
          },
          "vipps_transaction": {
            "card": {
              "id": "ca_fcfac2016614418f969fa5697383e47c",
              "state": "active",
              "customer": "customer00069",
              "reference": "cs_6be90a4babc3c57ef7e6e477ac97ed3b",
              "failed": "2015-06-04T12:40:56.656Z",
              "created": "2015-04-04T12:40:56.656Z",
              "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
              "reactivated": "2015-05-14T00:00:00Z",
              "gw_ref": "657e86162633415a9e6b715248c84da4",
              "card_type": "visa_dk",
              "transaction_card_type": "visa",
              "exp_date": "09-18",
              "masked_card": "457111XXXXXX3777",
              "last_success": "2015-05-14T00:00:00Z",
              "last_failed": "2015-05-14T00:00:00Z",
              "first_fail": "2015-05-14T00:00:00Z",
              "error_code": "credit_card_expired",
              "error_state": "hard_declined",
              "strong_authentication_status": "secured_by_nets",
              "three_d_secure_status": "Y",
              "card_country": "US"
            },
            "error": "credit_card_expired",
            "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
            "provider": "clearhaus",
            "frictionless": true,
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "gw_id": "28fc559a229e4fd3a134297a478a0075",
            "last_failed": "2015-04-04T12:40:56.656Z",
            "first_failed": "2015-04-04T12:40:56.656Z",
            "error_state": "hard_declined",
            "card_type": "visa_dk",
            "transaction_card_type": "visa",
            "exp_date": "09-18",
            "masked_card": "457111XXXXXX3777",
            "card_country": "US",
            "strong_authentication_status": "secured_by_nets",
            "three_d_secure_status": "Y",
            "acquirer_code": "40135",
            "acquirer_message": "Card expired",
            "acquirer_reference": "Card expired",
            "text_on_statement": "myshop.com 123",
            "surcharge_fee": 123,
            "cardholder_name": "Jane Doe"
          },
          "applepay_transaction": {
            "card": {
              "id": "ca_fcfac2016614418f969fa5697383e47c",
              "state": "active",
              "customer": "customer00069",
              "reference": "cs_6be90a4babc3c57ef7e6e477ac97ed3b",
              "failed": "2015-06-04T12:40:56.656Z",
              "created": "2015-04-04T12:40:56.656Z",
              "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
              "reactivated": "2015-05-14T00:00:00Z",
              "gw_ref": "657e86162633415a9e6b715248c84da4",
              "card_type": "visa_dk",
              "transaction_card_type": "visa",
              "exp_date": "09-18",
              "masked_card": "457111XXXXXX3777",
              "last_success": "2015-05-14T00:00:00Z",
              "last_failed": "2015-05-14T00:00:00Z",
              "first_fail": "2015-05-14T00:00:00Z",
              "error_code": "credit_card_expired",
              "error_state": "hard_declined",
              "strong_authentication_status": "secured_by_nets",
              "three_d_secure_status": "Y",
              "card_country": "US"
            },
            "error": "credit_card_expired",
            "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
            "provider": "clearhaus",
            "frictionless": true,
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "gw_id": "28fc559a229e4fd3a134297a478a0075",
            "last_failed": "2015-04-04T12:40:56.656Z",
            "first_failed": "2015-04-04T12:40:56.656Z",
            "error_state": "hard_declined",
            "card_type": "visa_dk",
            "transaction_card_type": "visa",
            "exp_date": "09-18",
            "masked_card": "457111XXXXXX3777",
            "card_country": "US",
            "strong_authentication_status": "secured_by_nets",
            "three_d_secure_status": "Y",
            "acquirer_code": "40135",
            "acquirer_message": "Card expired",
            "acquirer_reference": "Card expired",
            "text_on_statement": "myshop.com 123",
            "surcharge_fee": 123,
            "cardholder_name": "Jane Doe"
          },
          "googlepay_transaction": {
            "card": {
              "id": "ca_fcfac2016614418f969fa5697383e47c",
              "state": "active",
              "customer": "customer00069",
              "reference": "cs_6be90a4babc3c57ef7e6e477ac97ed3b",
              "failed": "2015-06-04T12:40:56.656Z",
              "created": "2015-04-04T12:40:56.656Z",
              "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
              "reactivated": "2015-05-14T00:00:00Z",
              "gw_ref": "657e86162633415a9e6b715248c84da4",
              "card_type": "visa_dk",
              "transaction_card_type": "visa",
              "exp_date": "09-18",
              "masked_card": "457111XXXXXX3777",
              "last_success": "2015-05-14T00:00:00Z",
              "last_failed": "2015-05-14T00:00:00Z",
              "first_fail": "2015-05-14T00:00:00Z",
              "error_code": "credit_card_expired",
              "error_state": "hard_declined",
              "strong_authentication_status": "secured_by_nets",
              "three_d_secure_status": "Y",
              "card_country": "US"
            },
            "error": "credit_card_expired",
            "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
            "provider": "clearhaus",
            "frictionless": true,
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "gw_id": "28fc559a229e4fd3a134297a478a0075",
            "last_failed": "2015-04-04T12:40:56.656Z",
            "first_failed": "2015-04-04T12:40:56.656Z",
            "error_state": "hard_declined",
            "card_type": "visa_dk",
            "transaction_card_type": "visa",
            "exp_date": "09-18",
            "masked_card": "457111XXXXXX3777",
            "card_country": "US",
            "strong_authentication_status": "secured_by_nets",
            "three_d_secure_status": "Y",
            "acquirer_code": "40135",
            "acquirer_message": "Card expired",
            "acquirer_reference": "Card expired",
            "text_on_statement": "myshop.com 123",
            "surcharge_fee": 123,
            "cardholder_name": "Jane Doe"
          },
          "manual_transaction": {
            "method": "cash",
            "comment": "Paid by cash in the shop",
            "reference": "231"
          },
          "viabill_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "viabill_id": "28fc559a229e4fd3a134297a478a0075"
          },
          "anyday_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "anyday_id": "28fc559a229e4fd3a134297a478a0075"
          },
          "santander_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "santander_id": "28fc559a229e4fd3a134297a478a0075"
          },
          "resurs_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "resurs_id": "28fc559a229e4fd3a134297a478a0075"
          },
          "klarna_transaction": {
            "error": "credit_card_expired",
            "type": "klarna_pay_later",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "klarna_id": "28fc559a229e4fd3a134297a478a0075"
          },
          "swish_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "swish_id": "28fc559a229e4fd3a134297a478a0075"
          },
          "paypal_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "paypal_id": "28fc559a229e4fd3a134297a478a0075"
          },
          "bancontact_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "bancontact_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "blik_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "blik_id": "28fc559a229e4fd3a134297a478a0070"
          },
          "giropay_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "giropay_id": "28fc559a229e4fd3a134297a478a0070"
          },
          "ideal_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "ideal_id": "28fc559a229e4fd3a134297a478a0070"
          },
          "p24_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "p24_id": "28fc559a229e4fd3a134297a478a0070"
          },
          "sepa_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "sepa_id": "28fc559a229e4fd3a134297a478a0070",
            "sepa_mandate": {
              "iban": "DE89370400440532013000",
              "sepa_mandate_bank_reference": "sr-39ef3e95179640db01aa382e0b117e8a"
            }
          },
          "trustly_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "trustly_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "verkkopankki_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "verkkopankki_id": "28fc559a229e4fd3a134297a478a0070"
          },
          "eps_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "eps_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "estonia_banks_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "estonia_banks_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "latvia_banks_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "latvia_banks_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "lithuania_banks_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "lithuania_banks_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "mbway_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "mb_way_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "multibanco_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "multibanco_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "mybank_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "mybank_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "payconiq_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "payconiq_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "paysafecard_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "paysafecard_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "paysera_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "paysera_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "postfinance_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "postfinance_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "satispay_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "satispay_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "wechatpay_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "wechatpay_id": "aa8400fd1245e991ce1ee20780168839"
          },
          "mps_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "mps_subscription": {
              "id": "ca_fcfac2016614418f969fa5697383e47c",
              "state": "active",
              "customer": "customer00069",
              "reference": "cs_6be90a4babc3c57ef7e6e477ac97ed3b",
              "failed": "2015-06-04T12:40:56.656Z",
              "created": "2015-04-04T12:40:56.656Z",
              "external_id": "mps_sub_001"
            }
          },
          "vipps_recurring_transaction": {
            "error": "credit_card_expired",
            "ref_transaction": "a7a7195c54f644369922d0dfe794dd0c",
            "error_state": "hard_declined",
            "acquirer_message": "Rejected",
            "vipps_recurring_id": "28fc559a229e4fd3a134297a478a0075"
          }
        }
      ],
      "accounting_number": "2023/00005",
      "download_url": "https://example.com/123"
    }
  ],
  "next_page_token": "MTYzMjkxNDc4NTAwMDoxMA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.