Retrieve a purchase invoice

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_invoices/PI-0001" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.purchase_invoices.purchase_invoices_dto.PurchaseInvoicesDto.PurchaseInvoiceRead;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<PurchaseInvoiceRead> response = client.purchaseInvoices().getPurchaseInvoice("PI-0001");
System.out.println(response.getMap());

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.PurchaseInvoices().GetPurchaseInvoice(context.Background(), "PI-0001", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "purchase_invoice": {
    "account": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "activity_logs": [
      "<unknown>"
    ],
    "alternate_due_date": "<string>",
    "alternate_issue_date": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "currency": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "name": "<string>",
      "object": "<string>"
    },
    "custom_attributes": [
      {
        "href": "<string>",
        "id": "<string>",
        "name": "<string>",
        "object": "<string>",
        "type": "<string>",
        "value": "<string>"
      }
    ],
    "custom_form": "<unknown>",
    "due_date": "<string>",
    "id": "<string>",
    "issue_date": "<string>",
    "kpis": {
      "credit_applied": "<string>",
      "credit_issued": "<string>",
      "deleted_on": "<unknown>",
      "last_amended_on": "<unknown>",
      "last_cancelled_on": "<unknown>",
      "last_payment_date": "<unknown>",
      "last_reactivated_on": "<unknown>",
      "object": "<string>",
      "outstanding": "<string>",
      "overdue": "<string>",
      "payment_applied": "<string>",
      "voided_on": "<unknown>"
    },
    "last_updated_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "last_updated_on": "<string>",
    "lines": [
      {
        "accounting_code": "<string>",
        "id": "<string>",
        "item": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "object": "<string>",
        "quantity": 123,
        "subtotal": "<string>",
        "tax": "<string>",
        "total": "<string>",
        "uom": "<string>",
        "version": 123,
        "warehouse": "<string>"
      }
    ],
    "object": "<string>",
    "origin": "<string>",
    "payment_status": "<string>",
    "price_tax_inclusive": true,
    "purchase_order": {
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "status": "<string>",
    "subtotal": "<string>",
    "tax": "<string>",
    "total": "<string>",
    "uuid": "<string>",
    "version": 123
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

purchase_invoices

{purchase_invoice_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_invoices/PI-0001" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.purchase_invoices.purchase_invoices_dto.PurchaseInvoicesDto.PurchaseInvoiceRead;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<PurchaseInvoiceRead> response = client.purchaseInvoices().getPurchaseInvoice("PI-0001");
System.out.println(response.getMap());

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.PurchaseInvoices().GetPurchaseInvoice(context.Background(), "PI-0001", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "purchase_invoice": {
    "account": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "activity_logs": [
      "<unknown>"
    ],
    "alternate_due_date": "<string>",
    "alternate_issue_date": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "currency": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "name": "<string>",
      "object": "<string>"
    },
    "custom_attributes": [
      {
        "href": "<string>",
        "id": "<string>",
        "name": "<string>",
        "object": "<string>",
        "type": "<string>",
        "value": "<string>"
      }
    ],
    "custom_form": "<unknown>",
    "due_date": "<string>",
    "id": "<string>",
    "issue_date": "<string>",
    "kpis": {
      "credit_applied": "<string>",
      "credit_issued": "<string>",
      "deleted_on": "<unknown>",
      "last_amended_on": "<unknown>",
      "last_cancelled_on": "<unknown>",
      "last_payment_date": "<unknown>",
      "last_reactivated_on": "<unknown>",
      "object": "<string>",
      "outstanding": "<string>",
      "overdue": "<string>",
      "payment_applied": "<string>",
      "voided_on": "<unknown>"
    },
    "last_updated_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "last_updated_on": "<string>",
    "lines": [
      {
        "accounting_code": "<string>",
        "id": "<string>",
        "item": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "object": "<string>",
        "quantity": 123,
        "subtotal": "<string>",
        "tax": "<string>",
        "total": "<string>",
        "uom": "<string>",
        "version": 123,
        "warehouse": "<string>"
      }
    ],
    "object": "<string>",
    "origin": "<string>",
    "payment_status": "<string>",
    "price_tax_inclusive": true,
    "purchase_order": {
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "status": "<string>",
    "subtotal": "<string>",
    "tax": "<string>",
    "total": "<string>",
    "uuid": "<string>",
    "version": 123
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Returns the purchase invoice with its supplier, lines, totals, payment status and KPIs under purchase_invoice.

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

purchase_invoice_id

string

required

The purchase invoice's id.

Response

The purchase invoice, under purchase_invoice.

purchase_invoice

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response