Skip to content

Invoice Status API

Invoice status API can be used to list or retrieve status of the invoices sent to Netvisor or similar system for your company throught the Mediani platform.

List example

Invoice Installment List

Paginated list of your invoice installments. Page size 500, ordered by value date.

Attribute Type Description
count Number Total count of invoice install installments
next String Next page URL
previous String Previous page URL
results Invoice Installment List of invoice installment objects

Invoice installment object

Attribute Type Description
id UUID ID of the invoice installment
order UUID ID of the order which invoice is made for
created_at DateTime When the installment was created
modifed_at DateTime When the installment was edited
installment_number Number Number of the installment eg. if you have invoice that is paid in three parts, there are installment_number 1-3 for that order
value_date String Date when transaction is carried out in YYYY-MM-DD format
due_date String Due date for installment in YYYY-MM-DD format
installment_share String Share of the installment in percent
installment_media_price Number Media price for this installment
installment_production_fees String Production fees for this installment
installment_data_transfer_fees String Data transfer fees for this installment
installment_status String Installment status, possible choices are:
not_applicable
sent
failed
waiting
cancelled
invoice_id String Invoice ID from accounting software
error_message String Error message received from accounting software
customer_name String Name of the customer of the order

List example

GET /api/invoice-statuses/

{
    "count": 543,
    "next": "https://mediani.fi/api/invoice-statuses/?page=2",
    "previous": null,
    "results": [
        {
            "id": "366e021a-aefe-4474-a8cd-b29673216dea",
            "order": "4d191a47-81ef-4a4d-b87f-33857d8a2141",
            "created_at": "2023-10-18T11:39:57.192672Z",
            "modified_at": "2023-10-18T12:00:02.428670Z",
            "installment_number": 2,
            "value_date": "2023-11-18",
            "due_date": "2023-11-01",
            "installment_share": 50,
            "installment_media_price": "200.00",
            "installment_production_fees": "25.00",
            "installment_data_transfer_fees": "10.00",
            "installment_status": "waiting",
            "invoice_id": "3173",
            "error_message": null,
            "customer_name": "Oy Customer Ab"
        },
        {
            "id": "76c697ef-8506-4333-9866-d7d623a71a5a",
            "order": "4d191a47-81ef-4a4d-b87f-33857d8a2141",
            "created_at": "2023-10-18T11:39:57.192672Z",
            "modified_at": "2023-10-18T12:00:02.428670Z",
            "installment_number": 1,
            "value_date": "2023-10-18",
            "due_date": "2023-10-01",
            "installment_share": 50,
            "installment_media_price": "200.00",
            "installment_production_fees": "25.00",
            "installment_data_transfer_fees": "10.00",
            "installment_status": "sent",
            "invoice_id": "3172",
            "error_message": "Invalid Response: <?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>\r\n<Root>\r\n    <ResponseStatus>\r\n        <Status>FAILED</Status>\r\n        <Status>INVALID_DATA :: Data form incorrect:. Country code not valid. Country code must be in ISO-3166 format: None</Status>\r\n        <TimeStamp>18.10.2023 14:39:57</TimeStamp>\r\n    </ResponseStatus>\r\n</Root>",
            "customer_name": "Oy Customer Ab"
        },
    ]
}
This API endpoint only supports listing.