Connect

List basic invoice info for product

Production

https://api.mediaconnect.no/capi

GET

/v1/customer/invoice/{productCode}

Invoice

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

This API returns a list of basic invoice info ordered by decending invoice date.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.mediaconnect.no/capi/v1/customer/invoice/?includeUnpaid&fromDate&toDate'

Response Example

200 - Success

{
    "invoices": [
        {
            "invoiceNumber": 1234,
            "companyCode": "COMP",
            "invoiceOfferCount": 1,
            "invoiceDate": "2019-06-12",
            "invoicePaymentStatus": "paid",
            "invoiceAmount": 295,
            "invoiceCurrency": "NOK",
            "invoiceHotelUrl": "http://mediaconnect.no/invoice/view/gkcb93qgt94ca6943bloitxgq4de",
            "invoiceDueDate": "2019-07-17",
            "invoiceType": "invoice",
            "paidAmount": 295,
            "description": "Weekly Magazine",
            "fromTime": "2019-06-12",
            "includeTime": "2019-06-12"
        }
    ]
}

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

productCode

string

required

Product code

<= 12 characters

Query Params

includeUnpaid

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.

fromDate

string <date>

optional

If date is specified, then from this date will be invoices/payments returned.
Specify the date in format: YYYY-MM-DD

toDate

string <date>

optional

If date is specified then up this date will be returned invoices/payments.
Specify the date in format: YYYY-MM-DD

Responses

🟢200OK

application/json

Body

invoices

array [object {14}]

optional

invoiceNumber

integer

optional

The unique number of the invoice for this company

>= 1

companyCode

string

optional

The company that owns this invoice

<= 12 characters

invoiceOfferCount

integer

optional

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

invoiceDate

string <date>

optional

The date of creating the invoice. Format: YYYY-MM-DD

invoicePaymentStatus

enum<string>

optional

The status of invoice payment:

paid: The invoice is paid

notPaid: The invoice is not paid

partiallyPaid: The invoice is partially paid

Allowed values:

paidnotPaidpartiallyPaid

invoiceAmount

number

optional

The amount for the first (and possibly only) offer on this invoice

>= 0

Multiple of:

0.01

invoiceCurrency

string

optional

Currency for the entire invoice has to follow the standard ISO4217 - alphabetic code.

<= 3 characters

invoiceHotelUrl

string

optional

Url to the PDF invoice

invoiceDueDate

string <date>

optional

Invoice due date. Format: YYYY-MM-DD

invoiceType

enum<string>

optional

The type of invoice:

invoice: Normal invoice (ex. first invoice)

reminderInvoice: A reminder on unpaid invoice

finalInvoice: It is the last and final invoice.

Allowed values:

invoicereminderInvoicefinalInvoice

paidAmount

number

optional

The amount that was paid on this invoice.

>= 0

Multiple of:

0.01

description

string

optional

The description of invoice ex. product name

<= 40 characters

fromTime

string

optional

This invoice covers the period from this issue/date. Format: YYYY-MM-DD

<= 10 characters

includeTime

string

optional

Including this issue/date Format: YYYY-MM-DD

<= 10 characters

🟠400Bad Request

🟠404Record Not Found

🟠429429

🔴500Server Error

List basic invoice info

List invoice address