Connect

List invoices and reminders for product

Production

https://api.mediaconnect.no/capi

GET

/v1/customer/invoice/payment/{product}

Invoice

The user needs to be logged in to use this endpoint, click here to read more.

Invoice, invoice payments API for customer.

In response is returned list of invoiced products for customer. This is also payments info if paid amount is specified.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.mediaconnect.no/capi/v1/customer/invoice/payment/?unpaid&from&to'

Response Example

200 - Success

{
    "invoices": [
        {
            "customerNumber": 563457,
            "product": "CO27409",
            "invoiceOfferCount": "1",
            "productName": "Weekly Magazine",
            "amount": 49,
            "invoiceDate": "2022-01-07",
            "invoiceNumber": "7435367",
            "companyCode": "5646903690",
            "paymentDate": "2022-01-17",
            "dueDate": "2022-01-21",
            "paymentStatus": "0",
            "invoiceAmount": "295.00",
            "paidAmount": 0,
            "paymentMethod": "A",
            "invoiceHotelUrl": "http://mediaconnect.no/invoice/view/gkcb93qgt94ca6943bloitxgq4de",
            "invoiceStatus": "Invoiced"
        }
    ],
    "reminders": [
        {
            "invoiceNumber": 7435367,
            "product": "CO27409",
            "fromTime": "2023-01-01",
            "includeTime": "2024-01-01",
            "reminderDate": 1560333600000,
            "amount": 49,
            "dueDate": 1561716000000,
            "reminderNumber": 1,
            "reminderType": "reminder",
            "invoiceHotelUrl": "http://mediaconnect.no/invoice/view/gkcb93qgt94ca6943bloitxgq4de"
        }
    ]
}

Request

Authorization

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://connectid.no/user/oauth/authorize

Token URL: https://connectid.no/user/oauth/token

Refresh URL: https://connectid.no/user/oauth/token

Scopes:

read-For all access

Path Params

product

string

required

product code

<= 12 characters

Query Params

unpaid

boolean

optional

Specifies if invoices returned should include unpaid invoices

true: The invoice list includes all invoices.

false: The invoice list only includes paid invoices.

from

string

optional

If date is specified, then from this date will be invoices/payments returned

If no dates are specified then will be returned last invoice for given (first) product on invoice.

Specify the date in format: YYYY-MM-DD.

<= 10 characters

string

optional

If date is specified then up this date will be returned invoices/payments.

Specify the date in format: YYYY-MM-DD.

<= 10 characters

Responses

🟢200OK

application/json

Body

invoices

array [object {17}]

optional

customerNumber

integer

optional

Customer number

product

string

optional

Product on invoice

<= 12 characters

productName

string

optional

Product description/name

<= 40 characters

amount

number

optional

Amount for product on invoice

Multiple of:

0.01

invoiceDate

string

optional

Invoice date, date in format: YYYY-MM-DD

invoiceNumber

string

optional

Invoice number

<= 10 characters

invoiceOfferCount

string

optional

Invoice offer count. If this is more than 1, this invoice contains alternative offers.

<= 1 characters

companyCode

string

optional

companyCode

<= 12 characters

paymentDate

string

optional

Date of payment, date in format: YYYY-MM-DD

paymentStatus

string

optional

Status of invoice payment/invoice reminder:

-1 - No more reminding

0 - Normal reminding

> 0 used for special purposes such as reminders on partially payed invoices.

invoiceAmount

number

optional

Amount for whole invoice

Multiple of:

0.01

invoiceVatAmount

number

optional

Tax amount on invoice line

Multiple of:

0.01

paidAmount

number

optional

Amount that was paid for this invoice

Multiple of:

0.01

paymentMethod

enum<string>

optional

Invoice payment method. Returned values:

A - normal payment

B - autodraw (auto giro)

C - credit card payment

D - einvoice

E - autodraw einvoice

F - recurring payment credit card

G - recurring payment SMS

H - recurring vipps

I - recurring kco (Klarna checkout)

J - recurring credit card payex

K - recurring nexi

Allowed values:

ABCDEFGHIJK

invoiceHotelUrl

string

optional

Url to invoice

invoiceStatus

enum<string>

optional

Status of invoice. Returned values:

notInvoiced - Not invoiced

invoiced - Invoiced

paid - Paid

cancelled - Cancelled

dunned - Dunned

Allowed values:

notInvoicedinvoicedpaidcancelleddunned

dueDate

string

optional

Due date, date in format: YYYY-MM-DD

reminders

array [object {11}]

optional

invoiceNumber

integer

optional

Invoice number

product

string

optional

Product on invoice

<= 12 characters

fromTime

string

optional

This invoice covers the period from this issue/date, date in format: YYYY-MM-DD

<= 10 characters

includeTime

string

optional

Including this issue/date, date in format: YYYY-MM-DD

<= 10 characters

reminderDate

integer

optional

Reminder date. Unix Epoch timestamps in milliseconds since 1st January 1970 UTC

amount

number

optional

Amount for whole invoice

Multiple of:

0.01

dueDate

integer

optional

Invoice due date. Unix Epoch timestamps in milliseconds since 1st January 1970 UTC

reminderNumber

integer

optional

Reminder number e.g. 1, 2 etc.

graceInvoiceCount

integer

optional

Grace invoice number e.g. 1, 2 etc.

reminderType

enum<string>

optional

Reminder type. Returned values:

reminder - normal reminder invoice

reminderStop - reminder stop invoice

graceInvoice - grace invoice

graceInvoiceReminder - grace invoice reminder

Allowed values:

reminderreminderStopgraceInvoicegraceInvoiceReminder

invoiceHotelUrl

string

optional

Url to reminder invoice

🟠400Bad Request

🟠429429

🔴500Server Error

List invoices and reminders

List basic invoice info