Objects
GetPaid GraphQL API is in alpha build and is subject to change without warning. While the overall schemas will not vary much, the fields could undergo major revision. (see GraphQL Best Practices for Versioning (opens in a new tab))
About Objects
This section gives references for all GraphQL objects found in the API, as well as a quick example on how to call data from regular HTTP calls.
Specification
BankAccount
Represents a Bank Account of an Employee.
FIELDS
| Name | Description |
|---|---|
| accountName ( string! ) | |
| accountNumber ( string! ) | |
| bankName ( string! ) |
Company
Represents a Company created its respective Organization.
FIELDS
| Name | Description |
|---|---|
| id ( id! ) | Node ID |
| accessWagePercentage ( float! ) | Percentage of wage that is made available to all Employees in this Company |
| country ( string! ) | Country code (ISO 3166-1 alpha-3) |
| createdAt ( isodate! ) | Date and Time this Node was created. |
| currency ( string! ) | Company currency code (ISO 4217) |
| name ( string! ) | Name of the Company |
| payCycle ( PayCycle! ) | |
| payCycleConfiguration ( PayCycleConfiguration ) | |
| serviceFeeFlatRate ( float ) | Service Fee flat amount. If specified, serviceFeeFlatRate will override serviceFeePercentage. |
| serviceFeePercentage ( float! ) | Service Fee percentage imposed on all transactions made in this Company |
| status ( CompanyStatusEnum! ) | Status of this Company |
| timezone ( string! ) | Fixed offset UTC time zone (ISO 8601) in the form 'UTC±hh:mm |
| updatedAt ( isodate! ) | Date and Time this Node was updated. |
| withdrawalLimit ( float ) | Per transaction withdrawal limit for all Transactions made in this Company |
CreateEmployeesPayload
Payload for creating Employees.
FIELDS
| Name | Description |
|---|---|
| batchId ( string! ) | |
| created ( [Employee!] ) | Employees that were created. |
| rejected ( [RejectedEmployee!] ) | Employees that were rejected. |
Employee
Represents an Employee in a Company.
FIELDS
| Name | Description |
|---|---|
| id ( id! ) | |
| availableWage ( float ) | |
| bankAccount ( BankAccount ) | |
| createdAt ( isodate! ) | Date and Time this Node was created. |
| department ( string! ) | |
| earnedWage ( float ) | |
| email ( string! ) | |
| mobile ( string ) | |
| name ( string! ) | |
| reference ( string! ) | |
| status ( EmployeeStatusEnum! ) | Status of this Employee |
| updatedAt ( isodate! ) | Date and Time this Node was updated. |
| wage ( float! ) |
MonthlyPayCycleConfiguration
Represents the monthly configuration rules for a Pay Cycle. See [Pay Cycle Rules] for more information.
FIELDS
| Name | Description |
|---|---|
| id ( id! ) | |
| bufferIncludesWeekends ( boolean! ) | |
| endOfPayCycleRule ( PayCycleRule! ) | |
| startOfBufferRule ( BufferRule! ) |
PayCycle
Contains date information about the current Pay Cycle.
FIELDS
| Name | Description |
|---|---|
| bufferEndDate ( string! ) | Current Buffer End Date |
| bufferStartDate ( string! ) | Current Buffer Start Date |
| payCycleEndDate ( string! ) | Current PayCycle End Date |
| payCycleStartDate ( string! ) | Current PayCycle Start Date |
PayCycleConfiguration
Represents the configuration rules that defines a Pay Cycle. See [Pay Cycle Rules] for more information.
FIELDS
| Name | Description |
|---|---|
| id ( id! ) | |
| monthly ( MonthlyPayCycleConfiguration ) | |
| semiMonthly ( SemimonthlyPayCycleConfiguration ) | |
| variation ( string! ) |
RejectedEmployee
Represents an Employee in a Company.
FIELDS
| Name | Description |
|---|---|
| department ( string! ) | |
| email ( string! ) | |
| mobile ( string ) | |
| name ( string! ) | |
| reason ( string ) | |
| reference ( string! ) | |
| status ( string ) | |
| wage ( float! ) |
SemimonthlyPayCycleConfiguration
Represents the semimonthly configuration rules for a Pay Cycle, if relevant. See [Pay Cycle Rules] for more information.
FIELDS
| Name | Description |
|---|---|
| id ( id! ) | |
| bufferIncludesWeekends ( boolean! ) | |
| endOfPayCycleRule ( string ) | |
| startOfBufferRule ( string ) |
Transaction
Represents a Transaction Withdrawal requested by an Employee.
FIELDS
| Name | Description |
|---|---|
| id ( id! ) | |
| companyId ( id! ) | |
| completedAt ( isodate ) | Date and Time this Transaction was completed. |
| createdAt ( isodate! ) | Date and Time this Node was created. |
| employeeId ( id! ) | |
| externalId ( string! ) | |
| grossAmount ( float! ) | |
| netAmount ( float! ) | |
| serviceFee ( float! ) | |
| status ( TransactionStatusEnum! ) | Status of this Transaction |
| updatedAt ( isodate! ) | Date and Time this Node was updated. |