Mutations
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 Mutations
In a GraphQL schema, the root type has a mutation type that defines operations for changing data on the server. These operations are similar to HTTP methods such as POST, PATCH, and DELETE.
Specification
createCompany
Create a new Company.
INPUT FIELDS
- input ( CreateCompanyInput! )
| Name | Description |
|---|---|
| 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) |
| id ( id! ) | Node ID |
| 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 |
createEmployees
INPUT FIELDS
- input ( CreateEmployeesInput! )
| Name | Description |
|---|---|
| batchId ( string! ) | |
| created ( [Employee!] ) | Employees that were created. |
| rejected ( [RejectedEmployee!] ) | Employees that were rejected. |
createTransaction
INPUT FIELDS
- input ( CreateTransactionInput! )
| Name | Description |
|---|---|
| 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! ) | |
| id ( id! ) | |
| netAmount ( float! ) | |
| serviceFee ( float! ) | |
| status ( TransactionStatusEnum! ) | Status of this Transaction |
| updatedAt ( isodate! ) | Date and Time this Node was updated. |
updateCompany
Update a Company.
INPUT FIELDS
- input ( UpdateCompanyInput! )
| Name | Description |
|---|---|
| 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) |
| id ( id! ) | Node ID |
| 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 |
updateEmployee
INPUT FIELDS
- input ( UpdateEmployeeInput! )
| Name | Description |
|---|---|
| availableWage ( float ) | |
| bankAccount ( BankAccount ) | |
| createdAt ( isodate! ) | Date and Time this Node was created. |
| department ( string! ) | |
| earnedWage ( float ) | |
| email ( string! ) | |
| id ( id! ) | |
| mobile ( string ) | |
| name ( string! ) | |
| reference ( string! ) | |
| status ( EmployeeStatusEnum! ) | Status of this Employee |
| updatedAt ( isodate! ) | Date and Time this Node was updated. |
| wage ( float! ) |