Statement invoices

A statement invoice is an itemized bill requesting payment that is due to an insurer from an agency bill producer for a single agency bill period. "Statement invoice" is Cloud API’s term for agency bill statements.

Note: Sometimes the terms "agency bill statement," "statement invoice," "statement," and "invoice" are used interchangeably in BillingCenter. For example, an agency bill statement’s identifying number is referred to as Statement # in the user interface and invoiceNumber in Cloud API. This is because in the data model, agency bill statements are a subtype of invoice.

To learn about statement invoices, see Agency bill in BillingCenter: Statement Bill.

You can query for statement invoices using Cloud API.

Query for statement invoices

Use the following endpoint to retrieve all of a producer’s statement invoices:

  • GET billing/v1/producers/{producerId}/invoices

You can also retrieve an individual statement invoice using the following endpoint. (Note that this endpoint can be used to retrieve account invoices as well.)

  • GET /invoices/{invoiceId}

For example, the following request retrieves all statement invoices on producer bc:154.

Command

GET /billing/v1/producers/bc:154/invoices

Response

{
    "count": 12,
    "data": [
        {
            "attributes": {
                "adHoc": false,
                "amount": {
                    "amount": "1050.00",
                    "currency": "usd"
                },
                "amountDue": {
                    "amount": "0.00",
                    "currency": "usd"
                },
                "eventDate": "2025-03-15",
                "id": "bc:SE0WN2N-xkYzmm_i1HFgK",
                "invoiceNumber": "1000000063",
                "netAmount": {
                    "amount": "1050.00",
                    "currency": "usd"
                },
                "netAmountPaid": {
                    "amount": "1000.00",
                    "currency": "usd"
                },
                "paymentDueDate": "2025-04-29",
                "status": {
                    "code": "due",
                    "name": "Due"
                },
                "subtype": "StatementInvoice"
            },
            "checksum": "4",
            "links": {
                "self": {
                    "href": "/billing/v1/invoices/bc:SE0WN2N-xkYzmm_i1HFgK",
                    "methods": [
                        "get",
                        "patch"
                    ]
                }
            }
        },
        {
            "attributes": {
                "adHoc": false,
                "amount": {
                    "amount": "500.00",
                    "currency": "usd"
                },
                "amountDue": {
                    "amount": "0.00",
                    "currency": "usd"
                },
                ...

You can add query parameters to filter or sort the returned statement invoices. For example, to retrieve only billed invoices, you could add the following to the end of the request: ?filter=status:eq:billed.

Retrieve a single invoice

The following request retrieves a single statement invoice.

Command

GET /billing/v1/invoices/bc:235

Response

{
    "data": {
        "attributes": {
            "adHoc": false,
            "allInvoiceItemsExactlyPaid": false,
            "amount": {
                "amount": "860.00",
                "currency": "usd"
            },
            "amountDue": {
                "amount": "560.00",
                "currency": "usd"
            },
            "eventDate": "2025-05-15",
            "id": "bc:235",
            "invoiceNumber": "1000000065",
            "netAmount": {
                "amount": "860.00",
                "currency": "usd"
            },
            "netAmountPaid": {
                "amount": "300.00",
                "currency": "usd"
            },
            "paymentDueDate": "2025-06-29",
            "primaryDirectBillEarned": {
                "amount": "0.00",
                "currency": "usd"
            },
            "status": {
                "code": "due",
                "name": "Due"
            },
            "subtype": "StatementInvoice"
        },
        ...
    }
}