Invoice

List invoice details

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.

SecurityAuthorization_Code

Request

query Parameters

companyCode required	string <= 12 characters Company invoice belongs to
invoiceNumber required	integer Invoice number
reminderNumber required	integer Reminder number. 0 for invoice

Responses

200

Response Schema: application/json

object

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/invoice/details

Request samples

curl

Response samples

application/json

{"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"
}
]
}
]
}
}

List invoices - client mode

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.

SecurityClient_Credentials

Request

path Parameters

customerNumber

required

integer

The customer number

query Parameters

from	string <= 10 characters 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.
to	string <= 10 characters 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.

Responses

200

Response Schema: application/json

Array of objects

400

Bad Request

404

Not Found

429

Too Many Requests

500

Internal Server Error

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

Request samples

curl

Response samples

application/json

{"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
}
]
}
]
}

List invoices for product - client mode

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.

SecurityClient_Credentials

Request

path Parameters

customerNumber required	integer The customer number
productCode required	string <= 12 characters The response is a list of invoiced products for customer.

query Parameters

from	string <= 10 characters 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.
to	string <= 10 characters 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.

Responses

200

Response Schema: application/json

Array of objects

400

Bad Request

404

Not Found

429

Too Many Requests

500

Internal Server Error

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

Request samples

curl

Response samples

application/json

{"clientInvoiceInfoList": [{"invoiceId": "1",
"invoiceDate": 1560333600000,
"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": 1561716000000,
"dueDate": 1561716000000,
"desc": ["Weekly Magazine"
],
"period": 1,
"periodUnit": "E",
"fromTime": "2019-06-12",
"incltime": "2020-06-12",
"invoiceLineInfo": [{"productCode": "CO27409",
"invoiceAmount": 84.54,
"invoiceVatAmount": 13.47,
"invoiceVatPercent": 36.73
}
]
}
]
}

List invoices and reminders

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.

SecurityAuthorization_Code

Request

query Parameters

unpaid	boolean 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 <= 10 characters 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.
to	string <= 10 characters If date is specified then up this date will be returned invoices/payments. Specify the date in format: YYYY-MM-DD.

Responses

200

Response Schema: application/json

	Array of objects
	Array of objects

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/invoice/payment

Request samples

curl

Response samples

application/json

{"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"
}
]
}

List invoices and reminders for product

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.

SecurityAuthorization_Code

Request

path Parameters

product

required

string <= 12 characters

product code

query Parameters

unpaid	boolean 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 <= 10 characters 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.
to	string <= 10 characters If date is specified then up this date will be returned invoices/payments. Specify the date in format: YYYY-MM-DD.

Responses

200

Response Schema: application/json

	Array of objects
	Array of objects

400

Bad Request

429

Too Many Requests

500

Internal Server Error

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

Request samples

curl

Response samples

application/json

{"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"
}
]
}

List basic invoice info

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.

SecurityAuthorization_Code

Request

query Parameters

includeUnpaid	boolean 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> If date is specified, then from this date will be invoices/payments returned. Format: YYYY-MM-DD
toDate	string <date> If date is specified then up this date will be returned invoices/payments. Format: YYYY-MM-DD

Responses

200

Response Schema: application/json

Array of objects

400

Bad Request

404

Not Found

429

Too Many Requests

500

Internal Server Error

get/v1/customer/invoice

Request samples

curl

Response samples

application/json

{"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"
}
]
}

List basic invoice info for product

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.

SecurityAuthorization_Code

Request

path Parameters

productCode

required

string <= 12 characters

Product code

query Parameters

includeUnpaid	boolean 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> If date is specified, then from this date will be invoices/payments returned. Specify the date in format: YYYY-MM-DD
toDate	string <date> If date is specified then up this date will be returned invoices/payments. Specify the date in format: YYYY-MM-DD

Responses

200

Response Schema: application/json

Array of objects

400

Bad Request

404

Not Found

429

Too Many Requests

500

Internal Server Error

get/v1/customer/invoice/{productCode}

Request samples

curl

Response samples

application/json

{"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"
}
]
}

➔ Next to InvoiceAddress