Get Source Invoice

gethttps://api.flxpoint.com/source-invoices/{id}

Use this when you want to pull source invoice data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Request

Example request

get/source-invoices/{id}

curl -X GET "https://api.flxpoint.com/source-invoices/{id}" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

200OKapplication/json

idinteger

invoiceStatusobject

namestring

allowedUnpaidPaidCreditedRefunded

handlestring

allowedunpaidpaidcreditedrefunded

insertedAtstring (date-time)

updatedAtstring (date-time)

purchaseOrderIdinteger

this field is deprecated, please use `fulfillmentRequestId`. The two fields are same.

fulfillmentRequestIdinteger

rmaIdinteger

sourceIdinteger

purchaseOrderNumberstring

this field is deprecated, please start using `fulfillmentRequestNumber`. The two fields are essentially same.

fulfillmentRequestNumberstring

invoiceNumberstring

invoiceDatestring (date-time)

totalCostnumber

totalProductCostnumber

totalShippingCostnumber

totalFeeCostnumber

totalTaxCostnumber

totalOtherCostnumber

totalQuantityinteger

accountingSyncedboolean

accountingSyncErrorstring

externalAccountingIdstring

invoiceItemsarray[InvoiceItem]

idinteger

invoiceIdinteger

invoiceItemTypeobjectrequired

namestring

allowedProductShippingFeeTaxOther

handlestring

allowedproductshippingfeetaxother

sourceVariantIdinteger (int64)

costnumber

skustringrequired

titlestring

quantityinteger

perUnitCostnumber

externalAccountingItemIdstring

customFieldsarray[Source Invoice Custom Field]

idinteger

namestring

valuestring

totalCreditCostnumber

customFieldsarray[Source Invoice Custom Field]

idinteger

namestring

valuestring

commissionnumberdeprecated

vendorPayoutIdinteger

Example response

{
  "id": 0,
  "invoiceStatus": {
    "name": "Unpaid",
    "handle": "unpaid"
  },
  "insertedAt": "2026-04-20T00:00:00Z",
  "updatedAt": "2026-04-20T00:00:00Z",
  "purchaseOrderId": 0,
  "fulfillmentRequestId": 0,
  "rmaId": 0,
  "sourceId": 0,
  "purchaseOrderNumber": "string",
  "fulfillmentRequestNumber": "string",
  "invoiceNumber": "string",
  "invoiceDate": "2026-04-20T00:00:00Z",
  "totalCost": 0,
  "totalProductCost": 0,
  "totalShippingCost": 0,
  "totalFeeCost": 0,
  "totalTaxCost": 0,
  "totalOtherCost": 0,
  "totalQuantity": 0,
  "accountingSynced": true,
  "accountingSyncError": "string",
  "externalAccountingId": "string",
  "invoiceItems": [
    {
      "id": 0,
      "invoiceId": 0,
      "invoiceItemType": {
        "name": "Product",
        "handle": "product"
      },
      "sourceVariantId": 0,
      "cost": 0,
      "sku": "string",
      "title": "string",
      "quantity": 0,
      "perUnitCost": 0,
      "externalAccountingItemId": "string",
      "customFields": [
        {
          "id": null,
          "name": null,
          "value": null
        }
      ]
    }
  ],
  "totalCreditCost": 0,
  "customFields": [
    {
      "id": 0,
      "name": "string",
      "value": "string"
    }
  ],
  "commission": 0,
  "vendorPayoutId": 0
}

400Bad Request

No schema documented for this status.

401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment

{
  "get": {
    "summary": "Get Source Invoice",
    "parameters": [],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Invoice"
            }
          }
        }
      },
      "400": {
        "description": "Bad Request"
      },
      "401": {
        "description": "Unauthorized"
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight