query · Module: Billing · Requires billing:read
Arguments
| Argument | Type | Description |
|---|---|---|
invoice | String | Filter by invoice. |
status | String | Filter by status. |
type | String | Filter by type. |
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
Returns
ReconciliationList!
| Field | Type |
|---|---|
data | [Reconciliation!]! |
has_more | Boolean |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query Reconciliations($limit: Int) {
reconciliations(limit: $limit) {
data {
id
object
type
status
livemode
created
updated
invoice
rules
lines {
invoice_line
shipment
result
expected {
amount
currency
}
billed {
amount
currency
}
cause
}
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"reconciliations": {
"data": [
{
"id": "rcn_1a2B3c",
"object": "reconciliation",
"type": "invoice_vs_shipments",
"status": "running",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"invoice": "invc_7Ff2",
"rules": "example",
"lines": [
{
"invoice_line": "example",
"shipment": "shp_1Q2w3E4r5T6y",
"result": "matched",
"expected": {
"amount": 1299,
"currency": "usd"
},
"billed": {
"amount": 1299,
"currency": "usd"
},
"cause": "example"
}
]
}
],
"has_more": true
}
}
}