mutation · Module: Billing · Requires billing:write
Arguments
| Argument | Type | Description |
|---|---|---|
input | ReconciliationInput | The fields for this operation. |
ReconciliationInput fields
| Field | Type |
|---|---|
type | ReconciliationInputType |
invoice | String |
rules | String |
status | ReconciliationInputStatus |
summary | JSON |
lines | [ReconciliationLineInput!] |
user_metadata | UserMetadataInput |
Returns
Reconciliation!
| Field | Type |
|---|---|
id | String! |
object | ReconciliationObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
type | ReconciliationType! |
invoice | String! |
rules | String |
status | ReconciliationStatus! |
summary | JSON |
lines | [ReconciliationLine!] |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
mutation CreateReconciliation($input: ReconciliationInput!) {
createReconciliation(input: $input) {
id
object
type
status
livemode
created
updated
invoice
rules
lines {
invoice_line
shipment
result
expected {
amount
currency
}
billed {
amount
currency
}
cause
}
}
}
{
"input": {
"type": "invoice_vs_shipments",
"invoice": "invc_7Ff2",
"rules": "example",
"status": "running",
"summary": {},
"lines": [
{
"invoice_line": "example",
"shipment": "shp_1Q2w3E4r5T6y",
"result": "matched",
"expected": {
"amount": 1299,
"currency": "usd"
}
}
]
}
}
{
"data": {
"createReconciliation": {
"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"
}
]
}
}
}