Search by invoice id

Information

---

This API allow you to search for all status related to an invoice by unique invoice identifier.

Link to swagger

This endpoint is synchronous

The role user is needed in order to use this endpoint

Endpoints

---

GET/v1/invoice/:invoiceId/status-history

Warning

All status in the Iopole system are marked as either seen or not seen. By default, if no webhook is defined, the status won't be flagged as seen. You must call the dedicated endpoint.

---

Path parameters

---

invoiceIdstring (uuid) - Required

Unique Iopole identifier of the invoice

---

Request

---

GET /v1/invoice/:invoiceId/status-history

bash

  curl -X 'GET'
  'https://api.ppd.iopole.fr//v1/invoice/32c9aec1-e6d6-4ddf-82a0-42dfa29268f8/status-history'
  -H 'accept: application/json'
  -H 'Authorization: Bearer ${TOKEN}'

javascript

    const got = require('got');
    const token = 'your_token_here';
    const invoiceId = '32c9aec1-e6d6-4ddf-82a0-42dfa29268f8';
    (async () => {
        try {
            const response = await got(`https://api.ppd.iopole.fr//v1/invoice/${invoiceId}/status-history`, {
                headers: {
                    'accept': 'application/json',
                    'Authorization': `Bearer ${token}`,
                },
                responseType: 'json',
            });
        
            console.log(response.body);
        } catch (error) {
            console.error(error.response.body);
        }
    })();

.NET

using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        var token = "your_token_here";
        var invoiceId = "32c9aec1-e6d6-4ddf-82a0-42dfa29268f8";
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("accept", "application/json");
        client.DefaultRequestHeaders.Add("Authorization", "Bearer ${token}");
        try
        {
            var response = await client.GetAsync("https://api.ppd.iopole.fr//v1/invoice/{invoiceId}/status-history");
            response.EnsureSuccessStatusCode();
            var responseString = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseString);
        }
        catch (HttpRequestException ex)
        {
            Console.WriteLine("Request error: {ex.Message}");
        }
    }
}

Response

---

200 OK

 [
  {
    "indentifier": "7583de97-88ff-49fc-bab6-f8cb5050aa9b",
    "invoiceId": "4f0a899d-2137-4515-8519-56b3665a75db",
    "statusId": "25f1451e-2881-4153-9492-6ebef46c4697",
    "date": "2023-04-13T13:10:46.719Z",
    "destType": "PLATFORM",
    "code": "APPROVED",
    "jsonLifecycle": {
      "document": {
        "category": {
          "code": "eInvoicing",
          "value": "S1"
        },
        "exchangedDocument": {
          "id": "Document ID",
          "name": "Document Name",
          "date": 1681391446000,
          "recipients": []
        },
        "acknowledgementDocuments": [
          {
            "multipleReferencesIndicator": false,
            "name": "MDT-76 : Nom document",
            "typeCode": "ACK",
            "date": 1681391446000,
            "referencedDocuments": [
              {
                "issuerAssignedId": "IH02103745",
                "typeCode": 380,
                "receiptDate": 1681391446000,
                "processCondition": {
                  "code": "APPROVED",
                  "value": "205",
                  "desc": "Approuvée"
                },
                "documentStatus": {
                  "generatedDate": 1681391446000,
                  "reason": "La facture a totalement été traitée par l’acheteur"
                }
              }
            ]
          }
        ]
      }
    },
    "xmlLifecycle": "..."
  },
  {
    "indentifier": "7583de97-88ff-49fc-bab6-f8cb5050aa9b",
    "invoiceId": "4f0a899d-2137-4515-8519-56b3665a75db",
    "statusId": "e7d9e859-8670-462f-8af8-67243adbb21b",
    "date": "2023-04-13T13:10:45.806Z",
    "destType": "PLATFORM",
    "code": "IN_HAND",
    "jsonLifecycle": {},
    "xmlLifecycle": "..."
  },
  {
    "indentifier": "7583de97-88ff-49fc-bab6-f8cb5050aa9b",
    "invoiceId": "4f0a899d-2137-4515-8519-56b3665a75db",
    "statusId": "6d768bad-767f-409c-893b-11a5fd543036",
    "date": "2023-04-13T13:10:40.723Z",
    "destType": "PLATFORM",
    "code": "MADE_AVAILABLE",
    "jsonLifecycle": {},
    "xmlLifecycle": "..."
  },
  {
    "indentifier": "7583de97-88ff-49fc-bab6-f8cb5050aa9b",
    "invoiceId": "4f0a899d-2137-4515-8519-56b3665a75db",
    "statusId": "db90286a-2294-445a-a249-3b675e2af9ed",
    "date": "2023-04-13T13:10:40.716Z",
    "destType": "PLATFORM",
    "code": "RECEIVED",
    "jsonLifecycle": {},
    "xmlLifecycle": "..."
  }
]

---