Input Objects
WARNING
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 Inputs
This section gives a quick example on how to form a GraphQL inputs, as well as a quick example on how to call data from regular HTTP.
Specification
BankAccountInput
CreateCompanyInput
INPUT FIELDS
| Name | Description |
|---|---|
| accessWagePercentage ( float! ) | |
| country ( CompanyCountryEnum ) | |
| name ( string! ) | |
| payCycleConfiguration ( CreatePayCycleConfigurationInput! ) | |
| serviceFeeFlatRate ( float ) | |
| serviceFeePercentage ( float! ) | |
| status ( CompanyStatusEnum ) | |
| withdrawalLimit ( float ) |
CreateEmployeesInput
INPUT FIELDS
| Name | Description |
|---|---|
| companyId ( id! ) | |
| employees ( [EmployeeInput!] ) |
CreatePayCycleConfigurationInput
INPUT FIELDS
| Name | Description |
|---|---|
| monthly ( PayCycleMonthlyInput! ) | |
| semiMonthly ( PayCycleSemimonthlyInput ) | |
| variation ( PayCycleVariationEnum! ) |
CreateTransactionInput
EmployeeInput
INPUT FIELDS
| Name | Description |
|---|---|
| bankAccount ( BankAccountInput! ) | |
| department ( string ) | |
| email ( string! ) | |
| mobile ( string ) | |
| name ( string! ) | |
| reference ( string ) | |
| wage ( float! ) |
PayCycleMonthlyInput
INPUT FIELDS
| Name | Description |
|---|---|
| bufferIncludesWeekends ( boolean ) | |
| endOfPayCycleRule ( PayCycleRule! ) | |
| startOfBufferRule ( BufferRule! ) |
PayCycleSemimonthlyInput
INPUT FIELDS
| Name | Description |
|---|---|
| bufferIncludesWeekends ( boolean ) | |
| endOfPayCycleRule ( string! ) | |
| startOfBufferRule ( string! ) |
SortInput
INPUT FIELDS
| Name | Description |
|---|---|
| createdAt ( SortInputEnum ) | |
| name ( SortInputEnum ) | |
| updatedAt ( SortInputEnum ) |
TransactionSortInput
INPUT FIELDS
| Name | Description |
|---|---|
| createdAt ( SortInputEnum ) | |
| updatedAt ( SortInputEnum ) |
UpdateCompanyInput
INPUT FIELDS
| Name | Description |
|---|---|
| accessWagePercentage ( float ) | |
| country ( CompanyCountryEnum ) | |
| createPayCycleConfiguration ( UpdatePayCycleConfigurationInput ) | Create a new PayCycleConfiguration version, superceding the current Pay Cycle Configuration setup. |
| id ( id! ) | |
| name ( string ) | |
| serviceFeeFlatRate ( float ) | |
| serviceFeePercentage ( float ) | |
| status ( CompanyStatusEnum ) | |
| withdrawalLimit ( float ) |
UpdateEmployeeInput
INPUT FIELDS
| Name | Description |
|---|---|
| companyId ( id! ) | |
| createBankAccountVersion ( BankAccountInput ) | Create a new bank account record for this employee, superceding the previous Bank Account version. |
| department ( string ) | |
| email ( string ) | |
| id ( id! ) | |
| mobile ( string ) | |
| name ( string ) | |
| reference ( string ) | |
| wage ( float ) |
UpdatePayCycleConfigurationInput
INPUT FIELDS
| Name | Description |
|---|---|
| monthly ( PayCycleMonthlyInput ) | |
| semiMonthly ( PayCycleSemimonthlyInput ) | |
| variation ( PayCycleVariationEnum ) |