Search by id

Information

---

This API allow you to search for an invoice by its unique identifier.

Link to swagger

This endpoint is synchronous

The role user is needed in order to use this endpoint

Endpoints

---

GET/v1/invoice/:invoiceId

---

Path parameters

---

invoiceIdstring (uuid) - Required

Unique Iopole identifier of the invoice

---

Request

---

GET /v1/invoice/:invoiceId

bash

  curl -X 'GET'
  'https://api.ppd.iopole.fr//v1/invoice/32c9aec1-e6d6-4ddf-82a0-42dfa29268f8'
  -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}`, {
            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}");
                response.EnsureSuccessStatusCode();
    
                var responseString = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseString);
            }
            catch (HttpRequestException ex)
            {
                Console.WriteLine("Request error: {ex.Message}");
            }
        }
}

Response

---

200 OK

 [
  {
    "type": 380,
    "processType": "B1",
    "invoiceId": "INV20240918-001",
    "invoiceDate": "20240918",
    "invoiceDueDate": "20241018",
    "buyer": {
      "name": "Example Buyer",
      "country": "FR",
      "siren": "987654321",
      "postalAddress": {
        "addressLineOne": "456 Buyer Avenue",
        "cityName": "Paris",
        "postalCode": "75002",
        "country": "FR"
      }
    },
    "seller": {
      "name": "Example Seller",
      "country": "FR",
      "siren": "123456789",
      "postalAddress": {
        "addressLineOne": "123 Seller Street",
        "cityName": "Paris",
        "postalCode": "75001",
        "country": "FR"
      }
    },
    "taxDetails": [
      {
        "taxableAmount": {
          "amount": 1000.0
        },
        "taxAmount": {
          "amount": 200.0
        },
        "taxType": "VAT",
        "categoryCode": "S",
        "percent": 20.0
      }
    ],
    "monetary": {
      "invoiceAmount": {
        "amount": 1200.0
      },
      "taxBasisTotalAmount": {
        "amount": 1000.0
      },
      "taxTotalAmount": {
        "amount": 200.0,
        "currency": "EUR"
      },
      "payableAmount": {
        "amount": 1200.0
      },
      "lineTotalAmount": {
        "amount": 1000.0
      },
      "invoiceCurrency": "EUR"
    }
  }
]

---