Invoice
Invoice Details

Get invoice details

To get the invoice details, proceed as follow:

End point: {BASE_URL}/invoice/get/{{invoice_uuid}}

Request method: GET

curl --location --request GET '{{BASE_URL}}/invoice/get/{{invoice_uuid}}' \
--header 'x-api-key: live_xxxxxxxxxxxxxxx' \
--header 'mode: live' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic xxxxxxxxxx' \

Request params

ParamètreMandatoryDescription
invoice_uuidYesThe unique identifier that identifies an invoice and that was generated at creation of an invoice

Response body :

{
  "status": "SUCCESS",
  "statusCode": 200,
  "message": "Invoice details",
  "data": {
    "uuid": "ed201c08-893b-40c5-9c7f-8fd65a3486df",
    "created_at": "2024-12-11T16:53:59.769Z",
    "lastChangedDateTime": "2024-12-11T16:53:59.769Z",
    "isDeleted": null,
    "ref": "INV-1733936039769",
    "total_amount": "120000",
    "amount_paid": "0",
    "remaining_amount": "120000",
    "sub_total": "120000",
    "status": "UNPAID",
    "type": "NORMAL",
    "partial_payment": false,
    "due_date": "2024-05-14T13:53:22.060Z",
    "callback_url": "https://webhook.site/697a81e2-6b63-4be1-928f-63b0100ea6bd",
    "is_custom_company": true,
    "custom_billing_company": {
      "logo": "https://static.vecteezy.com/system/resources/thumbnails/047/656/219/small_2x/abstract-logo-design-for-any-corporate-brand-business-company-vector.jpg",
      "name": "Alpha Company",
      "email": "[email protected]",
      "phone_number": "+237678095634"
    },
    "currency": "XAF",
    "client": {
      "uuid": "d2614f47-0fab-4c2d-9a62-eecd59553e54",
      "created_at": "2024-06-06T12:00:16.677Z",
      "lastChangedDateTime": "2024-06-06T12:00:16.677Z",
      "isDeleted": null,
      "name": "Brooklyn Perry",
      "email": "[email protected]",
      "phone_number": "(924) 913-0817"
    },
    "company": {
      "uuid": "5aae9972-d428-4c65-ab5a-662b6dc39b61",
      "created_at": "2024-06-06T11:44:01.765Z",
      "lastChangedDateTime": "2024-06-06T11:44:01.765Z",
      "isDeleted": null,
      "name": "Edi Fashoion",
      "slug": null,
      "email": "[email protected]",
      "phone_number": "23456734567",
      "logo": "https://payunit-public-assets-staging.s3.us-east-2.amazonaws.com/payunit-invoice/4ffbcc14-fedc-4437-8be6-d7975fbd056a/1717674241164.image/png",
      "user_id": "4ffbcc14-fedc-4437-8be6-d7975fbd056a",
      "application_id": "40dc357d-8f04-4bcf-a511-9207e7cd3156"
    },
    "payments": [],
    "items": [
      {
        "uuid": "fee96be9-d5a5-48a4-829a-1f11959b2b6f",
        "created_at": "2024-12-11T16:53:59.830Z",
        "lastChangedDateTime": "2024-12-11T16:53:59.769Z",
        "isDeleted": null,
        "name": "recovery partial",
        "ref": "ITEM1733936039827",
        "amount": "30000",
        "quantity": "4"
      }
    ],
    "installments": []
  }
}
Last updated on February 25, 2025