paymentReportItems
📖 Provides a paginated list of payment report items, filtered by report, crew, profile and report creation date.
Values match the profile payment report export in the admin app. They are copied when the report is created, except
expenses, which are read from the expense claim. Expenses are reported on the salary item of the same crew job, and an
EXPENSE item is returned only when the report has no salary item for it.
Items with crewInvoice set are paid through crew invoices rather than payroll. Use
crewInvoices to get them grouped into invoices.
🔭 Required scope: read:payment_reports.
type Query {paymentReportItems(input: PaymentReportItemsInput}
⬆️ Interactive type overview. Click type names or +/- buttons to expand/collapse definitions.
Examples
Get all items in a payment report
Request
query Example {
paymentReportItems(input: {filter: {paymentReportOids: [{id: "01ABCDEFGHIJKLMNOPQRS0011"}]}}) {
paginatedList {
crewOid { id }
itemType
roleName
start
end
hoursWorked
hourlyFee
basePay
holidayPay
totalSalary
expensesTotal
totalPayable
currency
expenses {
type
description
amount
receipt
}
crewInvoice
}
}
}
Response
{
"data": {
"paymentReportItems": {
"paginatedList": [
{
"crewOid": {
"id": "01ABCDEFGHIJKLMNOPQRS0021"
},
"itemType": "SALARY",
"roleName": "Bar & Catering (Bar Back)",
"start": "2025-01-14T10:00:00Z",
"end": "2025-01-14T18:00:00Z",
"hoursWorked": 7.5,
"hourlyFee": 20,
"basePay": 150,
"holidayPay": 18.11,
"totalSalary": 168.11,
"expensesTotal": 0,
"totalPayable": 168.11,
"currency": "gbp",
"expenses": [],
"crewInvoice": false
},
{
"crewOid": {
"id": "01ABCDEFGHIJKLMNOPQRS0022"
},
"itemType": "SALARY",
"roleName": "Healthcare (Nanny)",
"start": "2025-01-15T12:00:00Z",
"end": "2025-01-15T18:00:00Z",
"hoursWorked": 6,
"hourlyFee": 25,
"basePay": 150,
"holidayPay": null,
"totalSalary": 150,
"expensesTotal": 22.4,
"totalPayable": 172.4,
"currency": "gbp",
"expenses": [
{
"type": "Travel",
"description": "Return train fare",
"amount": 22.4,
"receipt": "https://..."
}
],
"crewInvoice": true
}
]
}
}
}
Related Types Schema
📜 Partial schema that includes all types used in this operation.
input PaymentReportItemsInput {
"""Filters payment report items based on different criteria"""
filter: PaymentReportItemsFilter
"""Pagination page. Default value is 1"""
page: Int = 1
"""Number of items per page. Default value is 100 and maximum is 100"""
perPage: Int = 100
}
input PaymentReportItemsFilter {
paymentReportIds: [ID!]
paymentReportOids: [ObjectIDInput!]
crewIds: [ID!]
crewOids: [ObjectIDInput!]
"""Profile when the report was created. Excludes legacy reports."""
profileIds: [ID!]
profileOids: [ObjectIDInput!]
crewInvoiceOnly: Boolean
reportCreatedAfter: Time
reportCreatedBefore: Time
}
input ObjectIDInput @oneOf {
"""Either ID or alias must be specified."""
id: String
alias: String
}
type PaymentReportItemsResponse {
"""Paginated list of returned payment report items."""
paginatedList: [PaymentReportItem!]!
"""Pagination pager with total count and current page"""
pager: Pager
}
"""A pagination Pager"""
type Pager {
"""Current pagination page"""
currentPage: Int!
"""Total number of pagination pages"""
pageCount: Int!
"""Maximum number of records per pagination page"""
perPage: Int!
"""Total number of records"""
totalCount: Int!
}
type PaymentReportItem {
paymentReportId: ID!
paymentReportOid: ObjectID!
itemType: PaymentReportItemType!
crewId: ID!
crewOid: ObjectID!
"""Workforce ID when the report was created"""
crewUniqueId: String!
"""Profile when the report was created. Null on legacy reports."""
profileId: ID
profileOid: ObjectID
profileName: String
crewJobId: ID!
crewJobOid: ObjectID!
jobId: ID!
jobOid: ObjectID!
boardName: String!
setName: String!
groupName: String!
internalJobTitle: String!
roleName: String!
"""Comma-separated client label names"""
clientName: String!
"""Comma-separated project-number label names"""
projectIds: String!
"""Worked period, in the job's timezone"""
start: Time!
end: Time!
"""IANA timezone name"""
timezone: String!
"""In minutes"""
breakPeriod: Int!
breakPeriodPaid: Boolean!
"""In hours. Always 1 unless feeType is PER_HOUR."""
roleDuration: Float!
"""
roleDuration less an unpaid break. Always 1 unless feeType is PER_HOUR.
"""
hoursWorked: Float!
feeType: FeeType!
"""Fee per hour for PER_HOUR roles, the fixed fee otherwise"""
hourlyFee: Float!
salary: Float!
bonus: Float!
fineNet: Float!
fineGross: Float!
subsistence: Float!
"""
With inclusive holiday pay, totalSalary less holidayPay. Otherwise equal to
salary.
"""
basePay: Float!
"""Null when holiday pay does not apply"""
holidayPay: Float
"""
salary plus bonus and subsistence, less fines, plus exclusive holiday pay
"""
totalSalary: Float!
expensesTotal: Float!
"""totalSalary plus expensesTotal"""
totalPayable: Float!
"""
ISO 4217 code, lower case, e.g. "gbp"
"""
currency: String!
"""Approved expenses, read from the expense claim rather than the report"""
expenses: [PaymentReportItemExpense!]!
"""
Paid by a crew invoice rather than through payroll. Reports created before
1 September 2022 predate crew invoices: their items can have this set, but
have no invoices.
"""
crewInvoice: Boolean!
}
enum FeeType {
PER_HOUR
PER_JOB
NO_FEE
}
type ObjectID {
id: String!
alias: String
type: ObjectType!
}
type PaymentReportItemExpense {
type: String
description: String
"""Where the expense was incurred"""
supplier: String
amount: Float!
"""Receipt URL, valid for 7 days"""
receipt: String
}
enum PaymentReportItemType {
SALARY
EXPENSE
}
enum ObjectType {
BOARD
JOB
JOB_ROLE
CREW_JOB
JOB_GROUP
JOB_LABEL
MULTI_DAY_JOB
BOARD_PUBLISH
USER
PROFILE
DATA_TYPE
DATA_TYPE_OPTION
CREW_TAG
PAYMENT_REPORT
CREW_NOTE
}
"""The `Boolean` scalar type represents `true` or `false`."""
scalar Boolean
"""
The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).
"""
scalar Float
"""
The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
"""
scalar ID
"""
The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
"""
scalar Int
"""
The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
"""
scalar String
"""
Datetime string in ISO 8601 format like "2020-11-18T12:21:14+00:00" or "2020-11-18T12:21:14Z"
"""
scalar Time