Agency Invoice API (1.0)
Download OpenAPI specification:
The Agency Invoice API is a read-only API providing access to summarized information on invoicing.
Invoicing summaries are available at the level of an agency office and an invoicing period.
If you have any questions, comments or feedback regarding our APIs, please contact developer@ovipro.fi.
Fetch agency office invoice summaries
Fetch agency office invoice summaries matching the search criteria
Usage examples
Get a specific invoice summary
GET /invoiceSummaries?agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e&invoicingPeriod=2021-01&productClass=SALES_ANNOUNCEMENT
Authorizations:
query Parameters
| agencyOfficeId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e Agency office identifier |
| invoicingPeriod required | string Example: invoicingPeriod=2021-02 The invoicing period a specific invoice summary applies to. Currently this is always a calendar month |
| productClass required | string Enum: "SALES_ANNOUNCEMENT" "PURCHASE_ANNOUNCEMENT" "RENTAL_ANNOUNCEMENT" "EXTRA_VISIBILITY" Example: productClass=SALES_ANNOUNCEMENT The class of products a specific invoice summary applies to. |
| portalCode required | string Enum: "ETUOVI" "VUOKRAOVI" Example: portalCode=ETUOVI The market place a specific invoice summary applies to. |
header Parameters
| Request-ID required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 Unique identifier of the call as determined by the initiating party. This identifier is used for troubleshooting purposes. |
Responses
Response samples
- 200
- 400
- 401
- 404
- 429
- 500
[- {
- "agencyOfficeId": "ac9de83f-2101-4d1a-a2fa-2e472d646e6e",
- "agencyOfficeName": "JaakonVälitys",
- "invoicingPeriod": "2021-02",
- "productClass": "SALES_ANNOUNCEMENT",
- "portalCode": "ETUOVI",
- "contracts": [
- {
- "productName": "Etuovi.com - Brändinäkyvyys",
- "currencyCode": "EUR",
- "basePrice": 20,
- "unitPrice": 12.5
}, - {
- "productName": "Etuovi.com - Laajakuva",
- "currencyCode": "EUR",
- "basePrice": 0,
- "unitPrice": 2
}
], - "itemGroupDiscounts": [
- {
- "discountType": "VOLUME_DISCOUNT",
- "itemGroups": [
- {
- "upperLimit": 20,
- "discountPercentage": 25
}, - {
- "lowerLimit": 21,
- "upperLimit": 50,
- "discountPercentage": 55
}, - {
- "lowerLimit": 50,
- "discountPercentage": 80
}
]
}
], - "otherDiscounts": [
- {
- "discountType": "ACTIVITY_TIME_DISCOUNT",
- "discountThresholdDays": 7,
- "discountPercentage": 50
}, - {
- "discountType": "SELLING_PRICE_DISCOUNT",
- "priceLimit": 15000,
- "discountPercentage": 50
}, - {
- "discountType": "MAXIMUM_PRICE_DISCOUNT",
- "currencyCode": "EUR",
- "maximumPrice": 15000
}
], - "agencyOffices": [
- {
- "agencyOfficeId": "f907f5ce-3d03-49b2-ae07-cb35b28bdccc",
- "agencyOfficeName": "Maijan Välitys LKV"
}, - {
- "agencyOfficeId": "b7520e6d-4bb0-4c07-b457-17ba3ceeed76",
- "agencyOfficeName": "Mikon Välitys LKV"
}, - {
- "agencyOfficeId": "ac9de83f-2101-4d1a-a2fa-2e472d646e6e",
- "agencyOfficeName": "JaakonVälitys"
}
], - "invoiceItems": {
- "total": {
- "currencyCode": "EUR",
- "price": 1300,
- "quantity": 3
}, - "items": [
- {
- "productName": "Etuovi.com - Brändinäkyvyys",
- "allowanceChargeCode": "CHARGE",
- "description": "Kuukausimaksu",
- "currencyCode": "EUR",
- "unitPrice": 90,
- "quantity": 1,
- "price": 90
}, - {
- "productName": "Etuovi.com - Brändinäkyvyys",
- "allowanceChargeCode": "DISCOUNT",
- "description": "Kuukausimaksu",
- "currencyCode": "EUR",
- "unitPrice": 40,
- "quantity": -1,
- "price": -40
}, - {
- "productName": "Etuovi.com - Brändinäkyvyys",
- "allowanceChargeCode": "CREDIT_NOTE",
- "description": "Kuukausimaksu",
- "currencyCode": "EUR",
- "unitPrice": 40,
- "quantity": -1,
- "price": -40
}, - {
- "productName": "Etuovi.com - Brändinäkyvyys",
- "allowanceChargeCode": "CHARGE",
- "description": "Kohteet",
- "currencyCode": "EUR",
- "unitPrice": 13,
- "quantity": 75,
- "price": 975
}, - {
- "productName": "Etuovi.com - Laajakuva",
- "allowanceChargeCode": "CHARGE",
- "description": "Kohteet",
- "currencyCode": "EUR",
- "unitPrice": 2,
- "quantity": 75,
- "price": 150
}
]
}
}
]Fetch invoice items related to an invoice summary
Fetch invoice items related to an invoice summary
Usage examples
List sales announcements related to specific invoice summary
GET /invoiceSummaryItems?agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e&invoicingPeriod=2021-01&productClass=SALES_ANNOUNCEMENT
List purchase announcements related to a specific invoice summary
GET /invoiceSummaryItems?agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e&invoicingPeriod=2021-01&productClass=PURCHASE_ANNOUNCEMENT
List extra visibility items related to a specific invoice summary
GET /invoiceSummaryItems?agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e&invoicingPeriod=2021-01&productClass=EXTRA_VISIBILITY
Authorizations:
query Parameters
| agencyOfficeId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e Agency office identifier |
| invoicingPeriod required | string Example: invoicingPeriod=2021-02 The invoicing period a specific invoice summary applies to. Currently this is always a calendar month |
| productClass required | string Enum: "SALES_ANNOUNCEMENT" "PURCHASE_ANNOUNCEMENT" "RENTAL_ANNOUNCEMENT" "EXTRA_VISIBILITY" Example: productClass=SALES_ANNOUNCEMENT The class of products a specific invoice summary applies to. |
| portalCode required | string Enum: "ETUOVI" "VUOKRAOVI" Example: portalCode=ETUOVI The market place a specific invoice summary applies to. |
header Parameters
| Request-ID required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 Unique identifier of the call as determined by the initiating party. This identifier is used for troubleshooting purposes. |
Responses
Response samples
- 200
- 400
- 401
- 404
- 429
- 500
{- "total": {
- "price": 7.5,
- "currencyCode": "EUR"
}, - "invoiceSummaryItems": [
- {
- "agencyOfficeId": "ac9de83f-2101-4d1a-a2fa-2e472d646e6e",
- "agencyOfficeName": "Solid House Oy LKV | Helsinki",
- "invoicingPeriod": "2021-01",
- "productClass": "SALES_ANNOUNCEMENT",
- "portalCode": "ETUOVI",
- "allowanceChargeCode": "CHARGE",
- "pricingGroup": "1-20",
- "announcementCode": "20089376",
- "announcementStreetAddress": "Siilitie 8 a",
- "publishingDate": "2021-03-01",
- "daysVisible": 7,
- "currencyCode": "EUR",
- "unitPrice": 15,
- "activityTimeDiscount": -7.5,
- "price": 7.5
}
]
}