Search by id

Information

---

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

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

---

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

---

Status: 200 - application/json

Description: Invoices id list received from given criteria

Schema:

Status: 401

Description: Unauthorized - Authentication is required and has failed or has not yet been provided.

Status: 403

Description: Forbidden - The server understood the request, but it refuses to authorize it. Note: This endpoint requires an admin account.

---