Get Invoice Details

GET /api/v1/Invoice/GetInvoiceDeatails

Description

This endpoint is used to retrieve details of a specific invoice. It expects the InvoiceId as a query parameter and returns a GetInvoiceDetailsByIdResponseFinalResponse object containing all details of the invoice.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Query Parameters:

• InvoiceId: string, required (format: uuid)

Request Body:

• None

URL:

• GET: {{baseUrl API url}}/api/v1/Invoice/GetInvoiceDeatails

Response:

• A GetInvoiceDetailsByIdResponseFinalResponse object containing all details of the invoice.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example Request URL:

GET /api/v1/Invoice/GetInvoiceDeatails?InvoiceId=98f2d2e5-6140-4f19-9b58-48c5003e92f7

Example Response:

HTTP/1.1 200 OK
{
  "invoiceId": "98f2d2e5-6140-4f19-9b58-48c5003e92f7",
  "counterpartyId": "9c2ac828-3677-4e50-b366-e11a12345678",
  "invoiceNumber": "INV00001",
  "amount": 100.00,
  "currency": "USD",
  "dueDate": "2024-03-01",
  "status": "Unpaid",
  "paymentDate": null
}

Notes:

• Please note that the query parameter InvoiceId must be a valid UUID format.

• The API response will contain details of the invoice with the specified InvoiceId.

Method: GET

/api/v1/Invoice/GetInvoiceDeatails?InvoiceId=<uuid>

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
InvoiceId	<uuid>

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "id": "<uuid>",
    "invoiceId": "<string>",
    "userId": "<uuid>",
    "counterPartyId": "<uuid>",
    "receivingAccountId": "<uuid>",
    "counterPartyName": "<string>",
    "accountName": "<string>",
    "dueDate": "<dateTime>",
    "currency": 1,
    "products": [
      {
        "productId": "<uuid>",
        "productName": "<string>",
        "quantity": "<integer>",
        "unitPrice": "<double>"
      },
      {
        "productId": "<uuid>",
        "productName": "<string>",
        "quantity": "<integer>",
        "unitPrice": "<double>"
      }
    ],
    "taxes": [
      {
        "taxId": "<uuid>",
        "taxName": "<string>",
        "taxPercentageValue": "<double>"
      },
      {
        "taxId": "<uuid>",
        "taxName": "<string>",
        "taxPercentageValue": "<double>"
      }
    ],
    "discount": {
      "discountType": 1,
      "discountValue": "<double>"
    },
    "description": "<string>",
    "billingCycle": 2,
    "recuringInvoice": "<boolean>",
    "notification": [
      "<integer>",
      "<integer>"
    ],
    "paymentOptions": "<string>",
    "beforeDueDate": 4,
    "afterDueDate": 1,
    "paymentMethods": [
      "<integer>",
      "<integer>"
    ],
    "beforeDueDates": [
      "<integer>",
      "<integer>"
    ],
    "afterDueDates": [
      "<integer>",
      "<integer>"
    ],
    "onDueDate": "<boolean>",
    "amount": "<double>",
    "subTotalAmount": "<double>",
    "created": "<dateTime>",
    "logo": {
      "id": "<uuid>",
      "name": "<string>",
      "path": "<string>",
      "previousPath": "<string>",
      "type": "<string>",
      "ownerId": "<uuid>",
      "approved": "<boolean>",
      "tenantId": "<uuid>"
    },
    "counterparty": {
      "id": "<uuid>",
      "userId": "<uuid>",
      "name": "<string>",
      "email": "<string>",
      "address": "<string>",
      "lei": "<string>",
      "country": "<string>",
      "phoneCode": "<string>",
      "phoneNumber": "<string>",
      "state": "<string>",
      "city": "<string>",
      "postalCode": "<string>",
      "merchantId": "<uuid>"
    },
    "invoiceAccountDetails": {
      "recievingAccountId": "<uuid>",
      "counterpartyId": "<uuid>",
      "invoiceId": "<uuid>",
      "accountNumber": "<string>",
      "accountName": "<string>",
      "id": "<uuid>",
      "merchantId": "<uuid>",
      "amount": "<double>",
      "bankName": "<string>",
      "amountReceivable": "<double>"
    },
    "businessDetails": {
      "companyName": "<string>",
      "country": "<string>",
      "state": "<string>",
      "registrationType": "<string>",
      "address": "<string>",
      "documentName": "<string>",
      "documentPath": "<string>",
      "ownerId": "<uuid>",
      "id": "<uuid>",
      "registrationDate": "<string>",
      "industry": "<string>",
      "numberOfStaff": "<string>",
      "websiteUrl": "<string>",
      "about": "<string>",
      "rcNumber": "<string>",
      "beneficiaryOwners": "<string>",
      "approved": "<boolean>",
      "verificationStatus": "<string>"
    },
    "invoiceStatus": 1,
    "amountPayable": "<double>",
    "paidAmount": "<double>"
  }
}