Invoice

Get invoice

Returns an invoice by internal id for the authenticated organisation.

get/invoice/{id}

Request

  • Base URL: https://api.paidnice.com/rest/v1
  • URL: https://api.paidnice.com/rest/v1/invoice/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:00000000-0000-0000-0000-000000000123

Response

The invoice

idstring required
accountingSystemIdstring required
statusstring required
numberstring
referencestring
currencystring required
frozenboolean required
sentToCustomerboolean required
dueAmountnumber required
totalAmountnumber required
subtotalAmountnumber required
taxAmountnumber required
paidAmountnumber required
discountAmountnumber required
creditedAmountnumber required
depositAmountnumber required
exchangeRatenumber required
accountingSystemExchangeRatenumber
issueDatestring required
dueDatestring required
lastSyncedDatestring
portalUrlstring required
accountingSystemOnlineUrlstring
contactIdinteger required
contactNamestring

Example response

{
  "id": "00000000-0000-0000-0000-000000000123",
  "accountingSystemId": "INV-123",
  "status": "AUTHORISED",
  "number": "INV-000123",
  "reference": "PO-456",
  "currency": "USD",
  "sentToCustomer": true,
  "dueAmount": 12.5,
  "totalAmount": 50,
  "subtotalAmount": 45,
  "taxAmount": 5,
  "paidAmount": 10,
  "discountAmount": 2,
  "creditedAmount": 3,
  "exchangeRate": 1,
  "accountingSystemExchangeRate": 1.25,
  "issueDate": "2026-06-01",
  "dueDate": "2026-06-15",
  "lastSyncedDate": "2026-06-16T08:00:00.000Z",
  "portalUrl": "https://portal.paidnice.com/i/abc123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.