Skip to main content
POST
/
api
/
rest
/
invoices
/
search
Search Invoices
curl --request POST \
  --url https://api.upwell.com/api/rest/invoices/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceSystem": "<string>",
  "sourceSystemId": "<string>",
  "limit": 10,
  "offset": 0,
  "orderBy": [],
  "where": {}
}
'
{
  "invoices": [
    {
      "balance": 123,
      "customer": {
        "id": "<string>",
        "name": "<string>"
      },
      "customerId": "<string>",
      "dueDate": "2023-12-25",
      "id": "<string>",
      "issueDate": "2023-12-25",
      "number": "<string>",
      "sourceSystem": "<string>",
      "sourceSystemId": "<string>",
      "status": "APPROVED",
      "totalAmount": 123,
      "invoiceNumber": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

​
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Query Parameters

​
limit
integer
default:10
​
offset
integer
default:0

Body

application/json

Query parameters can also be provided in the request body as a JSON object

​
sourceSystem
string
required

The source system identifier

​
sourceSystemId
string
required

The ID of the invoice in the source system

​
limit
integer | null
default:10
​
offset
integer | null
default:0
​
orderBy
object[] | null
​
where
InvoicesBoolExp · object

Boolean expression to filter rows from the table "invoices". All fields are combined with a logical 'AND'.

Response

200 - application/json

Responses for POST /api/rest/invoices/search

​
invoices
Invoices · object[]