List a quote's partial invoices

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/orders/ORD-0002/quote_partial_invoices" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.orders.orders_dto.OrdersDto.OrderQuotePartialInvoices;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<OrderQuotePartialInvoices> response = client.orders().getOrderQuotePartialInvoices("ORD-0002");
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.Orders().GetOrderQuotePartialInvoices(context.Background(), "ORD-0002", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "order": {
    "partial_invoices": "<array>"
  }
}

{
  "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

orders

{order_id}

quote_partial_invoices

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/orders/ORD-0002/quote_partial_invoices" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.orders.orders_dto.OrdersDto.OrderQuotePartialInvoices;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<OrderQuotePartialInvoices> response = client.orders().getOrderQuotePartialInvoices("ORD-0002");
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.Orders().GetOrderQuotePartialInvoices(context.Background(), "ORD-0002", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "order": {
    "partial_invoices": "<array>"
  }
}

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

Pass the order’s id. An order with no partial invoices returns an empty list, and a quote that has not been converted returns 400.

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

order_id

string

required

The order's id. For a quote that has not been converted the call returns 400.

Response

The partial invoices, under order.partial_invoices.

order

object

Show child attributes

Guides

API reference

List a quote's partial invoices

Authorizations

Path Parameters

Response