ACacculynx
invoices

Get Invoice

Changed on

Use this endpoint to get a specific Invoice.

get/invoices/{invoiceId}

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/invoices/{invoiceId}
  • Auth
    HTTP bearer

Path parameters

invoiceIdstring uuid required

The invoice's unique identifier

Response

OK

idstring uuid

The unique identifier of the invoice.

_linkstring

The unique URI of the invoice for the specified Job.

jobIdstring uuid

The unique identifier of the Job this invoice is for.

invoiceNumberstring

The number of the invoice.

invoiceSequencenumber

The sequential number assigned to the invoice as its created.

invoiceDatestring

The date/time the invoice in UTC format.

dueDatestring

The due date/time the invoice in UTC format.

currentInvoiceState'Paid' | 'Unpaid' | 'Void' | 'Draft'

An identifier that provides an understanding of the state of the invoice.

totalPricenumber

The total price of the invoice.

balanceDuenumber

The balance due left on the invoice.

invoiceNamestring

The user entered name of the invoice.

createdDatestring

The date/time the invoice was created in UTC format.

sortIndexnumber

The order the invoice will appear in the list when sorted by invoice sequence.

recordingStatusstring

Status of the invoice integration with external accounting integration.

recordingClassificationstring

The user selected classification of the invoice set when recording the invoice.

Example response

{
  "id": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
  "_link": "https://api.acculynx.com/api/v2/invoices/01a7cfc1-2231-4589-9657-7f3004c06bd3",
  "jobId": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
  "invoiceNumber": "10-1",
  "invoiceDate": "2015-07-28T17:48:59Z",
  "dueDate": "2015-07-28T17:48:59Z",
  "currentInvoiceState": "Paid",
  "createdDate": "2015-07-28T17:48:59Z",
  "sections": [
    {
      "id": "43bc3071-8701-4514-92d2-0ab6934bbacc",
      "invoiceWorksheetSectionType": "Invoice",
      "items": [
        {
          "id": "79bd84ff-a16a-4358-b1de-be5071c0f19c",
          "parentItemId": "79bd84ff-a16a-4358-b1de-be5071c0f19c",
          "referenceId": "cc16cfe4-28d9-4fe4-b281-0e24fc0b4d83",
          "referenceType": "SKU",
          "tradeId": "e8ea8f4c-14ca-4bdf-8fe6-882410316757"
        }
      ]
    }
  ]
}

Changes

  • 443924b00f43Revision changes
    • breaking

      the //// response's property format changed from uri to no format for status