Get Statement
Last updated
Was this helpful?
Last updated
Was this helpful?
GET /public/v1/billing/statements/{id} HTTP/1.1
Host:
Accept: */*
{
"$meta": {
"omitted": [
"text"
]
},
"name": "Sample Entity",
"icon": "icon.png",
"audit": {
"created": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"generated": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text"
}
},
"queued": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text"
}
},
"error": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text"
}
},
"cancelled": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text"
}
},
"issued": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text"
}
},
"generating": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text"
}
}
},
"id": "SOM-1234-1234-1234-1234-1234",
"externalIds": {
"operations": "OPS-12345",
"vendor": "VND-67890",
"erpId": "ERP-12345"
},
"ledger": {
"name": "Sample Entity",
"icon": "icon.png",
"id": "BLE-1234-1234-1234-1234"
},
"customLedger": {
"icon": "icon.png",
"id": "text",
"name": "Quarterly Revenue Ledger"
},
"type": "Debit",
"billingType": "Automated",
"status": "Generated",
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text",
"erpLink": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"blocked": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"unblocked": {
"at": "2025-05-30T14:22:35.854Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"name": "text",
"status": "text",
"note": "text",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
}
}
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text"
},
"icon": "text",
"status": "text"
},
"agreement": {
"id": "text",
"icon": "text",
"status": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"price": {
"markup": 15.5,
"margin": 20,
"totalPP": 1000,
"totalSP": 1200,
"currency": {
"purchase": "USD",
"sale": "EUR",
"rate": 1
},
"totalGT": 1500.75,
"totalST": 1200.5
},
"processing": {
"total": 100,
"ready": 80,
"error": 5,
"split": 10,
"skipped": 5
},
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"error": {
"errorCode": "ERR-001",
"errorMessage": "Invalid billing data provided.",
"id": "12345",
"message": "Failed to process the billing entity due to missing data."
},
"invoice": {
"icon": "icon.png",
"id": "INV-123-456-789",
"name": "Oct 2015"
}
}