Retrieve an item receipt

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/item_receipts/ir_4e5f60718293a4b5c6d7e8f90a1b2c3d" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.itemReceipts.getItemReceipt('ir_4e5f60718293a4b5c6d7e8f90a1b2c3d');
console.log(response.data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.item_receipts.item_receipts_dto.ItemReceiptsDto.ItemReceipt;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ItemReceipt> response = client.itemReceipts().getItemReceipt("ir_4e5f60718293a4b5c6d7e8f90a1b2c3d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ItemReceipts.GetItemReceiptAsync("ir_4e5f60718293a4b5c6d7e8f90a1b2c3d");

Console.WriteLine(response.Json);

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

{
  "item_receipt": {
    "code": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "last_updated_on": "<string>",
    "lines": [
      {
        "item": {
          "code": "<string>",
          "href": "<string>",
          "id": "<string>",
          "name": "<string>",
          "object": "<string>"
        },
        "pending_return_quantity": 123,
        "purchase_order_line": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "receipt_quantity": 123,
        "received_quantity": 123,
        "returned_quantity": 123,
        "uom": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "warehouse": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        }
      }
    ],
    "object": "<string>",
    "purchase_order": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "receipt_date": "<string>",
    "receipt_note": "<string>",
    "receipt_status": "<string>",
    "receive_completed": true,
    "status": "<string>",
    "tracking_number": "<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

item_receipts

{item_receipt_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/item_receipts/ir_4e5f60718293a4b5c6d7e8f90a1b2c3d" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.itemReceipts.getItemReceipt('ir_4e5f60718293a4b5c6d7e8f90a1b2c3d');
console.log(response.data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.item_receipts.item_receipts_dto.ItemReceiptsDto.ItemReceipt;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ItemReceipt> response = client.itemReceipts().getItemReceipt("ir_4e5f60718293a4b5c6d7e8f90a1b2c3d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ItemReceipts.GetItemReceiptAsync("ir_4e5f60718293a4b5c6d7e8f90a1b2c3d");

Console.WriteLine(response.Json);

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

{
  "item_receipt": {
    "code": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "last_updated_on": "<string>",
    "lines": [
      {
        "item": {
          "code": "<string>",
          "href": "<string>",
          "id": "<string>",
          "name": "<string>",
          "object": "<string>"
        },
        "pending_return_quantity": 123,
        "purchase_order_line": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "receipt_quantity": 123,
        "received_quantity": 123,
        "returned_quantity": 123,
        "uom": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "warehouse": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        }
      }
    ],
    "object": "<string>",
    "purchase_order": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "receipt_date": "<string>",
    "receipt_note": "<string>",
    "receipt_status": "<string>",
    "receive_completed": true,
    "status": "<string>",
    "tracking_number": "<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 receipt under item_receipt, with its purchase order, status, dates, tracking_number and lines.

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

item_receipt_id

string

required

The receipt's id, which starts with ir_.

Response

The receipt, under item_receipt.

item_receipt

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response