Get Invoice | Coperniq | Developer Docs

curl https://api.coperniq.io/v1/invoices/invoiceId \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json"

{
  "id": 1024,
  "uid": 4587,
  "title": "Website Development Invoice",
  "status": "SENT",
  "amount": 12500,
  "amountPaid": 5000,
  "calculationMethod": "LINE_ITEMS",
  "createdAt": "2024-03-20T10:15:00Z",
  "updatedAt": "2024-03-25T14:45:00Z",
  "description": "Invoice for website development services rendered in March 2024",
  "basedOnId": 512,
  "basedOnUid": 2048,
  "dueDate": "2024-04-15T17:00:00Z",
  "isArchived": false,
  "sharedWithPortal": true,
  "percentage": 15,
  "baseAmount": 10869.57,
  "account": {
    "id": 305,
    "title": "Acme Corporation"
  },
  "record": {
    "id": 789,
    "uid": 1234,
    "title": "Project Alpha"
  },
  "lineItems": [
    {
      "id": 1,
      "catalogItemId": 101,
      "quantity": 1,
      "unitCost": 8000,
      "unitPrice": 10000,
      "description": "Frontend development services",
      "catalogItem": {
        "id": 101,
        "name": "Frontend Development",
        "sku": "SRV-FRONTEND-001",
        "type": "SERVICE"
      }
    },
    {
      "id": 2,
      "catalogItemId": 102,
      "quantity": 1,
      "unitCost": 2000,
      "unitPrice": 2500,
      "description": "Backend development services",
      "catalogItem": {
        "id": 102,
        "name": "Backend Development",
        "sku": "SRV-BACKEND-001",
        "type": "SERVICE"
      }
    },
    {
      "id": 3,
      "catalogItemId": 103,
      "quantity": 5,
      "unitCost": 100,
      "unitPrice": 150,
      "description": "API integration licenses",
      "catalogItem": {
        "id": 103,
        "name": "API Integration License",
        "manufacturer": "TechSoft",
        "sku": "PROD-API-INT-005",
        "type": "PRODUCT"
      }
    }
  ]
}

Retrieve a specific invoice by ID

Authentication

x-api-keystring

API Key authentication via header

Path parameters

invoiceIdstringRequired

Invoice identifier

Response

Invoice details

idinteger

Invoice identifier

uidinteger

Unique invoice number

titlestring

Invoice title

statusenum

Invoice status

amountdouble

Total invoice amount

amountPaiddouble

Amount paid

calculationMethodstring

Calculation method (e.g., LINE_ITEMS)

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

descriptionstring or null

Invoice description

typeenum or null

Invoice type

Allowed values:

basedOnIdinteger or null

ID of the record this invoice is based on

basedOnUidinteger or null

UID of the record this invoice is based on

dueDatestring or nullformat: "date-time"

Due date

isArchivedboolean or null

Whether the invoice is archived

sharedWithPortalboolean or null

Whether the invoice is shared with portal

percentagedouble or null

Percentage if applicable

baseAmountdouble or null

Base amount if applicable

accountobject or null

recordobject or null

lineItemslist of objects or null

Authentication

Path parameters

Response

Errors