v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB

Invoices

Get invoice by Id

get/1.0/invoices/{invoiceId}

Path parameters

invoiceIdinteger required

Unique identifier of the invoice

Query parameters

includeFieldsstring[]

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeAllFieldsboolean

Example:true

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

Response

The requested action was successfully executed.

invoiceIdinteger

Unique identifier of the invoice

invoiceNumberstring

Invoice number assigned to this invoice

dateOfIssuestring

Date when the invoice was issued. The format for the issue date is YYYY-MM-DD

dueDatestring

Due date for the invoice payment. The format for the due date is YYYY-MM-DD

currency'AFN' | 'ALL' | 'DZD' | 'ARS' | 'AMD' | 'AUD' | 'AZN' | 'BHD' | 'BDT' | 'BYN' | 'BZD' | 'BOB' | 'BAM' | 'BWP' | 'BRL' | 'GBP' | 'BND' | 'BGN' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DJF' | 'DOP' | 'EGP' | 'ERN' | 'EEK' | 'ETB' | 'EUR' | 'GEL' | 'GHS' | 'GTQ' | 'GNF' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'LVL' | 'LBP' | 'LYD' | 'LTL' | 'MOP' | 'MKD' | 'MGA' | 'MYR' | 'MUR' | 'MXN' | 'MDL' | 'MAD' | 'MZN' | 'MMK' | 'NAD' | 'NPR' | 'TWD' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PKR' | 'PAB' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'SAR' | 'RSD' | 'SGD' | 'SOS' | 'ZAR' | 'KRW' | 'LKR' | 'SDG' | 'SEK' | 'CHF' | 'SYP' | 'TZS' | 'THB' | 'TOP' | 'TTD' | 'TND' | 'TRY' | 'USD' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'XOF' | 'YER' | 'ZMK' | 'ZWL'

Currency of the invoice amount

statusstring

Current status of the invoice

amountnumber

Total amount of the invoice including tax

taxnumber

Tax amount applied to the invoice

subTotalnumber

Total amount of the invoice excluding tax

amountOutstandingnumber

Balance amount remaining to be paid

amountPaidnumber

Total amount paid for this invoice

amountWrittenOffnumber

Total amount written off for this invoice

notesstring

Notes or additional information about the invoice

createdAtinteger

Timestamp when the invoice was created

updatedAtinteger

Timestamp when the invoice was last updated

Example response

{
  "invoiceId": 201,
  "invoiceNumber": "INV-2024-001",
  "dateOfIssue": "2023-03-28",
  "dueDate": "2023-03-28",
  "currency": "USD",
  "status": "DRAFT",
  "amount": 1000.25,
  "tax": 100.25,
  "subTotal": 1000.25,
  "amountOutstanding": 500.25,
  "amountPaid": 500.25,
  "amountWrittenOff": 500.25,
  "notes": "This is the default address",
  "createdAt": 1681319726000,
  "updatedAt": 1681319726000,
  "createdBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "updatedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "company": {
    "companyId": 201,
    "companyName": "Acme Inc",
    "companyUrl": "https://www.acme.com"
  },
  "projects": [
    {
      "projectId": 201,
      "projectName": "Acme onboarding"
    }
  ],
  "fields": [
    {
      "fieldId": 201,
      "fieldLabel": "MRR",
      "fieldValueLabel": "1000"
    }
  ],
  "attachments": [
    {
      "attachmentId": 201,
      "attachmentName": "test_upload.png",
      "createdAt": 1680616174929,
      "location": "https://rocketlane.com/attachments/0/db83eb19-0bbf-4a37-b4e2-cd1b96708c73/test_upload.png",
      "thumbLocation": "https://rocketlane.com/attachments/0/db83eb19-0bbf-4a37-b4e2-cd1b96708c73/thumb_test_upload.png"
    }
  ]
}