Retrieve an invoice line

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/invoices/INV-0001/lines/4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.invoices.getInvoiceLine('INV-0001', '4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->invoices->getInvoiceLine('INV-0001', '4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a');
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.invoices.invoices_dto.InvoicesDto.InvoiceLineRead;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<InvoiceLineRead> response = client.invoices().getInvoiceLine(
        "INV-0001",
        "4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Invoices.GetInvoiceLineAsync(
    "INV-0001",
    "4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.invoices.getInvoiceLine(
  'INV-0001',
  '4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Invoices().GetInvoiceLine(context.Background(), "INV-0001", "4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "invoice": {
    "object": "<string>",
    "line": {
      "object": "<string>",
      "id": "<string>",
      "version": 123,
      "item": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "item_id": "<string>",
      "item_uuid": "<string>",
      "item_name": "<string>",
      "item_uom": "<string>",
      "item_warehouse": "<string>",
      "item_serial_or_batch_number": "<string>",
      "item_order_quantity": 123,
      "item_charge_type": "<string>",
      "item_custom_attributes": [
        "<unknown>"
      ],
      "pricing_snapshot_price": 123,
      "pricing_snapshot_uuid": "<string>",
      "charging_start_date": "<string>",
      "charging_end_date": "<string>",
      "alternate_charging_start_date": "<string>",
      "alternate_charging_end_date": "<string>",
      "subtotal": "<string>",
      "total": "<string>",
      "tax": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "rate": 123,
        "amount": "<string>",
        "href": "<string>"
      },
      "accounting_code": {
        "sales_revenue": "<string>"
      }
    }
  }
}

GET

invoices

{invoice_id}

lines

{line_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/invoices/INV-0001/lines/4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.invoices.getInvoiceLine('INV-0001', '4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->invoices->getInvoiceLine('INV-0001', '4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a');
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.invoices.invoices_dto.InvoicesDto.InvoiceLineRead;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<InvoiceLineRead> response = client.invoices().getInvoiceLine(
        "INV-0001",
        "4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Invoices.GetInvoiceLineAsync(
    "INV-0001",
    "4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.invoices.getInvoiceLine(
  'INV-0001',
  '4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Invoices().GetInvoiceLine(context.Background(), "INV-0001", "4d2e6f8a-1b3c-4d5e-9f0a-2b4c6d8e0f1a", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "invoice": {
    "object": "<string>",
    "line": {
      "object": "<string>",
      "id": "<string>",
      "version": 123,
      "item": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "item_id": "<string>",
      "item_uuid": "<string>",
      "item_name": "<string>",
      "item_uom": "<string>",
      "item_warehouse": "<string>",
      "item_serial_or_batch_number": "<string>",
      "item_order_quantity": 123,
      "item_charge_type": "<string>",
      "item_custom_attributes": [
        "<unknown>"
      ],
      "pricing_snapshot_price": 123,
      "pricing_snapshot_uuid": "<string>",
      "charging_start_date": "<string>",
      "charging_end_date": "<string>",
      "alternate_charging_start_date": "<string>",
      "alternate_charging_end_date": "<string>",
      "subtotal": "<string>",
      "total": "<string>",
      "tax": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "rate": 123,
        "amount": "<string>",
        "href": "<string>"
      },
      "accounting_code": {
        "sales_revenue": "<string>"
      }
    }
  }
}

Fetches a line under invoice.line. To find a specific line, use the lines endpoint.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

invoice_id

string

required

The invoice's id, such as INV-0001. Not its uuid.

line_id

string

required

The line's id.

Response

200 - application/json

The line, under invoice.line.

invoice

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response