Queries
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 Queries
In a GraphQL schema, the root type serves as the entry point for queries and mutations. The query type within the root type specifies the operations that can be used to retrieve data from the server.
For more information see "Making a Call."
Specification
companies
List all companies for the authenticated Partner.
Type: [Company!]
ARGUMENTS
| Name | Description |
|---|---|
| orderBy ( SortInput ) | Sort the results returned. |
| skip ( int ) | Skip the first 'n' nodes. |
| take ( int ) | Take 'n' nodes from position of the cursor |
company
employee
Retrieve an employee by ID.
Type: Employee!
ARGUMENTS
| Name | Description |
|---|---|
| id ( string! ) | Employee unique reference ID |
employees
List all employees in a Company.
Type: [Employee!]
ARGUMENTS
| Name | Description |
|---|---|
| companyId ( string! ) | Company unique reference ID |
| orderBy ( SortInput ) | Sort the results returned. |
| skip ( int ) | Skip the first 'n' nodes. |
| take ( int ) | Take 'n' nodes from position of the cursor |
transaction
Retrieve a transaction by ID.
Type: Transaction!
ARGUMENTS
| Name | Description |
|---|---|
| id ( string! ) | Transaction unique reference ID |
transactions
List all transactions in a Company.
Type: [Transaction!]
ARGUMENTS
| Name | Description |
|---|---|
| companyId ( string! ) | Company unique reference ID |
| employeeId ( string ) | Optional filter PersonAtCompany unique reference ID |
| orderBy ( TransactionSortInput ) | Sort transactions |
| skip ( int ) | Skip the first 'n' nodes. |
| take ( int ) | Take 'n' nodes from position of the cursor |