Querying for bulk invoices
Use the following endpoints to query for bulk invoices:
- GET
/claim/v1/bulk-invoices - GET
/claim/v1/bulk-invoices/{bulkInvoiceId}
Retrieve all bulk invoices
The first endpoint retrieves a collection of all existing bulk invoices by default and their details. For example, the following request retrieves all available bulk invoices in your system:
Command
GET /claim/v1/bulk-invoicesResponse
{
"count": 2,
"data": [
{
"attributes": {
"id": "xc:SF3EIyYvshoSm2pwaUnT_",
"invoiceNumber": "bulk-invoice-001",
"payTo": "Stan Newton",
"payee": {
"addressBookUID": "ab:1",
"authorizationID": "Sc9srn3wXG-ANV-P8KQYH",
"cellPhone": {
"countryCode": {
"code": "US",
"name": "United States (1)"
},
"displayName": "818-557-2317",
"number": "8185572317"
},
"displayName": "Stan Newton",
"emailAddress1": "0000@guidewire.com",
"emailAddress2": "0000@hotmail.com",
"firstName": "Stan",
"id": "xc:SUO44Bu7JCdqX60-35md_",
"lastName": "Newton",
"primaryPhone": "818-446-1206",
"primaryPhoneType": {
"code": "work",
"name": "Work"
},
"subtype": {
"code": "Person",
"name": "Person"
},
"taxId": "123-45-6790",
"workPhone": {
"displayName": "818-446-1206",
"number": "8184461206"
}
},
"scheduledSendDate": "2026-03-10T00:00:00.000Z",
"status": {
"code": "draft",
"name": "Draft"
},
"totalTransactionAmount": {
"amount": "0.00",
"currency": "usd"
}
},
{
"attributes": {
"id": "xc:SU1I47iQTC4eh6UcvJQ5t",
"invoiceNumber": "bulk-invoice-002",
"payTo": "Ray Timothy",
"payee": {
"addressBookUID": "ab:14",
"authorizationID": "S0yW4NRM0QDR3fmgWao7B",
"cellPhone": {
"countryCode": {
"code": "US",
"name": "United States (1)"
},
"displayName": "476-498-6086",
"number": "4764986086"
},
"displayName": "Ray Timothy",
"emailAddress1": "0000@guidewire.com",
"emailAddress2": "0000@hotmail.com",
"firstName": "Ray",
"id": "xc:SxdlXRe5JbEduWjO0_dDC",
"lastName": "Timothy",
"primaryPhone": "309-627-7271",
"primaryPhoneType": {
"code": "work",
"name": "Work"
},
"subtype": {
"code": "Person",
"name": "Person"
},
"taxId": "631-98-8492",
"workPhone": {
"displayName": "309-627-7271",
"number": "3096277271"
}
},
"scheduledSendDate": "2026-03-10T00:00:00.000Z",
"status": {
"code": "draft",
"name": "Draft"
},
"totalTransactionAmount": {
"amount": "0.00",
"currency": "usd"
}
}
]
}Retrieve a bulk invoice by ID
The second endpoint retrieves a specific bulk invoice by its id. In
addition to only retrieving one specific bulk invoice, this endpoint retrieves
additional useful details about the bulk invoice, such as the payee's address
information, for example.
If you don't know the ID of the bulk invoice you want to retrieve, you can use the
first endpoint to get the id. Then you can retrieve the bulk
invoice by that id. For example, the following request retrieves
'bulk-invoice-002' by its id:
Command
GET /claim/v1/bulk-invoices/xc:SU1I47iQTC4eh6UcvJQ5tResponse
{
"data": {
"attributes": {
"approvalStatus": {
"code": "unapproved",
"name": "Unapproved"
},
"approvedReportingAmount": {
"amount": "0.00",
"currency": "usd"
},
"approvedTransactionAmount": {
"amount": "0.00",
"currency": "usd"
},
"bulkInvoiceTotal": "500.00",
"currency": {
"code": "usd",
"name": "USD"
},
"deliveryMethod": {
"code": "send",
"name": "Send"
},
"id": "xc:SU1I47iQTC4eh6UcvJQ5t",
"invoiceNumber": "bulk-invoice-002",
"mailTo": "Ray Timothy",
"mailingAddress": {
"addressLine1": "287 Kensington Rd. #1A",
"addressType": {
"code": "home",
"name": "Home"
},
"city": "South Pasadena",
"country": "US",
"displayName": "287 Kensington Rd. #1A, South Pasadena, CA 91145",
"id": "cc:SNQZ48UPBeVUcDOeTSm8T",
"postalCode": "91145",
"state": {
"code": "CA",
"name": "California"
}
},
"payTo": "Ray Timothy",
"payee": {
"addressBookUID": "ab:14",
"authorizationID": "S0yW4NRM0QDR3fmgWao7B",
"cellPhone": {
"countryCode": {
"code": "US",
"name": "United States (1)"
},
"displayName": "476-498-6086",
"number": "4764986086"
},
"displayName": "Ray Timothy",
"emailAddress1": "0000@guidewire.com",
"emailAddress2": "0000@hotmail.com",
"firstName": "Ray",
"id": "xc:SxdlXRe5JbEduWjO0_dDC",
"lastName": "Timothy",
"primaryAddress": {
"addressBookUID": "xc:SErD6YA5wqChnFLdSW6IP",
"addressLine1": "287 Kensington Rd. #1A",
"addressType": {
"code": "home",
"name": "Home"
},
"city": "South Pasadena",
"country": "US",
"displayName": "287 Kensington Rd. #1A, South Pasadena, CA 91145",
"id": "cc:SM3Wfb52gMEVYFkc9WIvm",
"postalCode": "91145",
"state": {
"code": "CA",
"name": "California"
}
},
"primaryPhone": "309-627-7271",
"primaryPhoneType": {
"code": "work",
"name": "Work"
},
"subtype": {
"code": "Person",
"name": "Person"
},
"taxId": "631-98-8492",
"workPhone": {
"displayName": "309-627-7271",
"number": "3096277271"
}
},
"payeeAddressBookUID": "ab:14",
"paymentMethod": {
"code": "check",
"name": "Check"
},
"receivedDate": "2026-03-10T00:00:00.000Z",
"reportability": {
"code": "reportable",
"name": "Reportable"
},
"requestingUser": {
"displayName": "Super User",
"id": "default_data:1",
"type": "User",
"uri": "/admin/v1/users/default_data:1"
},
"scheduledSendDate": "2026-03-10T00:00:00.000Z",
"splitEqually": true,
"status": {
"code": "draft",
"name": "Draft"
},
"totalReportingAmount": {
"amount": "0.00",
"currency": "usd"
},
"totalTransactionAmount": {
"amount": "0.00",
"currency": "usd"
},
"valid": false
}
}
}The API responds with only the details for 'bulk-invoice-002'. This response includes additional details beyond what is returned when you retrieve all bulk invoices.