ACacculynx
jobs

Get Job Invoices

Changed on

Use this endpoint to get a list of invoices for the specified job.

get/jobs/{jobId}/invoices

Request

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

Path parameters

jobIdstring uuid required

The job's unique identifier

Query parameters

pageSizeinteger

How many items to be returned at a time.

pageStartIndexinteger

The index of the page to return

sortOrder'Ascending' | 'Descending'

The sort direction for the results. Defaults to Ascending.

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

{
  "items": [
    {
      "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

      for the query request parameter pageSize, default value 25 was removed

    • breaking

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

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status