List invoice details

Production

https://api.mediaconnect.no/capi

GET

/v1/customer/invoice/details

Invoice

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

Retrieves information regarding one invoice based on company code, invoice number and reminder number. Information about offers and details in the offer and lines are presented.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.mediaconnect.no/capi/v1/customer/invoice/details?companyCode&invoiceNumber&reminderNumber'

Response Example

200 - Success

{
    "invoiceInfoWithDetail": {
        "invoiceNumber": 7,
        "companyCode": "FTOTT",
        "invoiceOfferCount": 1,
        "invoiceDate": "2018-01-17",
        "invoicePaymentStatus": "partiallyPaid",
        "invoiceAmount": 110,
        "invoiceCurrency": "NOK",
        "invoiceHotelUrl": "www.invoicehotel.no",
        "invoiceDueDate": "2018-01-17",
        "invoiceType": "invoice",
        "paidAmount": 0,
        "description": "Toten testprodukt",
        "fromTime": "2020-01-01",
        "includeTime": "2021-01-01",
        "invoiceOfferInfo": [
            {
                "offerNumber": 1,
                "invoiceAmount": 100,
                "invoiceVatAmount": 10,
                "customerIdentification": "1234567",
                "invoiceLineInfoList": [
                    {
                        "productCode": "TOTT",
                        "invoiceAmount": 50,
                        "invoiceVatAmount": 5,
                        "invoiceVatPercent": 10,
                        "description": "TOTEN TEST",
                        "fromTime": "2018-01-01",
                        "includeTime": "2018-06-01"
                    },
                    {
                        "productCode": "PORTO",
                        "invoiceAmount": 50,
                        "invoiceVatAmount": 5,
                        "invoiceVatPercent": 10,
                        "description": "Porto til utland"
                    }
                ]
            }
        ]
    }
}

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

Query Params

companyCode

string

required

Company invoice belongs to

<= 12 characters

invoiceNumber

integer

required

Invoice number

reminderNumber

integer

required

Reminder number. 0 for invoice

Responses

🟢200OK

application/json

Body

invoiceInfoWithDetail

object

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

invoiceOfferInfo

array [object {5}]

optional

🟠400Bad Request

🟠429429

🔴500Server Error

List voucher code coupons - client mode

List invoices - client mode