List invoices - client mode

Production

https://api.mediaconnect.no/capi

GET

/v1/client/customer/invoice/payment/{customerNumber}

Invoice

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

The API for extracting information about payment history and paymentMethod for a customer based on customerNumber.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Success

{
    "clientInvoiceInfoList": [
        {
            "invoiceId": "1",
            "invoiceDate": 1701903600000,
            "invoiceOfferCount": "1",
            "customerNumber": 563457,
            "product": "CO27409",
            "productName": "Weekly Magazine",
            "amount": 2,
            "companyCode": "5646903690",
            "paymentStatus": "0",
            "invoiceAmount": 295,
            "paidAmount": 0,
            "paymentMethod": "A",
            "invoiceHotelUrl": "http://mediaconnect.no/invoice/view/gkcb93qgt94ca6943bloitxgq4de",
            "paymentDate": 1701903600000,
            "dueDate": 1701903600000,
            "desc": [
                "Weekly Magazine"
            ],
            "period": 1,
            "periodUnit": "E",
            "fromTime": "2023-12-08",
            "incltime": "2024-02-15",
            "invoiceLineInfo": [
                {
                    "productCode": "CO27409",
                    "invoiceAmount": 84.54,
                    "invoiceVatAmount": 13.47,
                    "invoiceVatPercent": 36.73
                }
            ]
        }
    ]
}

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

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

Example:

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

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

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

Scopes:

read-For all access

Path Params

customerNumber

integer

required

The customer number

Query Params

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.

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

Responses

🟢200OK

application/json

Body

clientInvoiceInfoList

array [object {21}]

optional

invoiceId

string

optional

Invoice Id

invoiceDate

integer

optional

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

invoiceOfferCount

string

optional

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

<= 1 characters

customerNumber

integer

optional

Customer number

product

string

optional

Product code on invoice

<= 12 characters

productName

string

optional

Product name

<= 40 characters

amount

number

optional

Amount for product on invoice

Multiple of:

0.01

companyCode

string

optional

Invoice number

<= 12 characters

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

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

paymentDate

integer

optional

Date of payment. Unix Epoch timestamps in milliseconds since 1st January 1970 UTC

dueDate

integer

optional

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

desc

array[string]

optional

List of descriptions, ie. what products are paid on the invoice.(you can have mulitple proudcts or mulitple payments on same product)

period

number <double>

optional

No. of issues/periods invoiced for.

periodUnit

enum<string>

optional

Units of period.

A - issues/periods from smissue-table

B - days

C - months

D - years

E - Issues within the given period

F - Issues with date oriented sub/mem

Allowed values:

ABCDEF

fromTime

string

optional

This is invoice from this issue/date, date in format: YYYY-MM-DD.

<= 10 characters

inclTime

string

optional

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

<= 10 characters

invoiceLineInfo

array [object {4}]

optional

Details regarding the invoice lines.

🟠400Bad Request

🟠404Record Not Found

🟠429429

🔴500Server Error

List invoice details

List invoices for product - client mode