Enums
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 Enums
Enums are unique values in their own right, rather than being references to a numeric value. They can be serialized as strings, which are the names of the represented values.
For example, the BankAccount object has a field called status. The status is an enum (specifically, of type String).
For more information, see "About the GraphQL API"
Specification
CompanyCountryEnum
ENUM VALUES
| Name | Description |
|---|---|
| IDN | Indonesia |
| IND | India |
| MYS | Malaysia |
| PHL | Philippines |
| SGP | Singapore |
| VNM | Vietnam |
CompanyStatusEnum
ENUM VALUES
| Name | Description |
|---|---|
| ACTIVE | |
| DEACTIVATED | |
| PENDING |
EmployeeStatusEnum
ENUM VALUES
| Name | Description |
|---|---|
| ACTIVE | |
| DEACTIVATED | |
| UNCLAIMED |
PayCycleVariationEnum
ENUM VALUES
| Name | Description |
|---|---|
| MONTHLY_SEMIMONTHLY | Monthly and/or Semi-Monthly PayCycle Configurations |
SortInputEnum
ENUM VALUES
| Name | Description |
|---|---|
| asc | Ascending |
| desc | Descending |
TransactionStatusEnum
ENUM VALUES
| Name | Description |
|---|---|
| Blocked | Transaction has been blocked, either by erroneous Bank Account or by Company disapproval. |
| Complete | Transaction has been approved and funds transferred. |
| Pending | Transaction is in pending state awaiting approval. |