Invoices & invoice payments
Get Invoice Payments
Returns the org's invoice payments with payable amounts.
GEThttps://api.toku.com/hris/get-invoice-payments
Not available to API keys.
curl --request GET \
--url 'https://api.toku.com/hris/get-invoice-payments?status=DRAFT' \
--header 'Authorization: Bearer <token>'200 response
{
"invoices": [
{
"approvalRevision": 0,
"invoicePaymentID": "string",
"roleInOrgID": "string",
"externalInvoiceID": "string",
"contractorEmail": "string",
"contractorName": "string",
"invoiceNumber": "string",
"invoiceDate": "string",
"dueDate": "string",
"totalAmount": "string",
"currencyCode": "string",
"status": "string",
"reason": "string",
"rejectionReason": "string",
"autoApproved": true,
"notes": "string",
"submissionTimestamp": "string",
"payoutHrisBankAccountId": "string",
"createdAt": "string",
"updatedAt": "string",
"roleInOrg": {
"hrAutomationOnly": true,
"isServiceSeat": true,
"invoiceApproverRoutingUpdatedAt": "string",
"legacyMigratedAt": "string",
"legacyModelID": 0,
"roleInOrgID": "string",
"personID": "string",
"orgID": "string",
"invitedByInvestorID": "string",
"invitedByRecipientID": "string",
"roleInOrgExternalID": 0,
"externalEmployeeID": "string",
"positionID": "string",
"jobTitle": "string",
"country": "string",
"countryCode": "string",
"preferredInvoiceCurrency": "string",
"status": "string",
"lifecycleStatus": "string",
"workEmail": "string",
"department": "string",
"legalEntity": "string",
"payrollEntity": "string",
"contractEntityID": "string",
"onboarded": true,
"isTerminated": true,
"privilegedAdmin": true,
"isPrimaryAdmin": true,
"isOrgMarketMaker": true,
"role": "string",
"employmentType": "string",
"revokedAt": "string",
"createdAt": "string",
"updatedAt": "string",
"payrollEmployeeID": "string",
"hasWelcomeEmailSent": true,
"subEmploymentType": "string",
"remarks": "string",
"isITAdmin": true,
"isExternalEmployee": true,
"employeeSyncedSource": "string",
"investorFullName": "string",
"baseSalary": "string",
"baseSalaryCurrency": "string",
"baseSalaryPaymentType": "string",
"baseSalaryTokenTypeID": "string",
"baseSalaryTokenSymbol": "string",
"baseSalaryTokenNetwork": "string",
"baseSalaryPeriod": "string",
"stablecoinPayPercentage": 0,
"maxStablecoinPercentage": 0,
"taxMethod": "string",
"withholdingPercentage": "string",
"lastLogin": "string",
"lastTestTxReminderBy": "string",
"lastTestTxReminderAt": "string",
"payrollFileNumber": "string",
"externalPayrollId": "string",
"lastOnboardingReminderBy": "string",
"lastOnboardingReminderAt": "string",
"address": "string",
"payrollGroup": "string",
"lastInactiveWalletReminderBy": "string",
"lastInactiveWalletReminderAt": "string",
"recipientType": "string",
"receiveNotificationEmails": true,
"receiveInAppNotifications": true,
"notificationEmailFrequency": "string",
"receiveSlackNotifications": true,
"selfServeContractorOnboardingStatus": "string",
"selfServeContractorOnboardingCompletedAt": "string",
"selfServeWelcomeEmailSentAt": "string",
"numberOfPayPeriodsPerYear": 0,
"managerRoleInOrgID": "string",
"managerPath": [
"string"
],
"person": {
"personID": "string",
"givenName": "string",
"familyName": "string",
"middleName": "string",
"createdAt": "string",
"updatedAt": "string",
"legacyMigratedAt": "string",
"legacyModelID": 0,
"mergedIntoPersonID": "string",
"mergedAt": "string",
"fullName": "string"
}
},
"totalPayableAmount": 0,
"totalPayableExchangeRate": 0
}
]
}Authorizations
AuthorizationstringheaderrequiredBearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.
Query parameters
statusstringrequiredAvailable options: DRAFT, PENDING, APPROVED, REJECTED, CANCELLED, FAILED, COMPLETED
Response
200Successful response
invoicesobject[]requiredShow child attributes
approvalRevisionintegerrequiredinvoicePaymentIDstringrequiredroleInOrgIDstringrequiredexternalInvoiceIDstringrequiredcontractorEmailstringrequiredcontractorNamestringrequiredinvoiceNumberstringrequiredinvoiceDatestringrequireddueDatestring | nullrequiredtotalAmountstringrequiredAllowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$
currencyCodestringrequiredlineItemsanyrequiredstatusstringrequiredreasonstring | nullrequiredrejectionReasonstring | nullrequiredautoApprovedbooleanrequirednotesstring | nullrequiredattachmentsanyrequiredsubmissionTimestampstringrequiredpayoutHrisBankAccountIdstring | nullrequiredpayoutBankSnapshotanyrequiredbillToSnapshotanyrequiredcreatedAtstringrequiredupdatedAtstringrequiredroleInOrgobjectShow child attributes
hrAutomationOnlybooleanrequiredisServiceSeatbooleanrequiredinvoiceApproverRoutingUpdatedAtstring | nullrequiredlegacyMigratedAtstring | nullrequiredlegacyModelIDinteger | nullrequiredroleInOrgIDstringrequiredpersonIDstringrequiredorgIDstringrequiredinvitedByInvestorIDstring | nullrequiredinvitedByRecipientIDstring | nullrequiredroleInOrgExternalIDintegerrequiredexternalEmployeeIDstring | nullrequiredpositionIDstring | nullrequiredjobTitlestring | nullrequiredcountrystring | nullrequiredcountryCodestring | nullrequiredpreferredInvoiceCurrencystring | nullrequiredstatusstring | nullrequiredlifecycleStatusstring | nullrequiredworkEmailstring | nullrequireddepartmentstring | nullrequiredlegalEntitystring | nullrequiredpayrollEntitystring | nullrequiredcontractEntityIDstring | nullrequiredonboardedbooleanrequiredisTerminatedbooleanrequiredprivilegedAdminbooleanrequiredisPrimaryAdminbooleanrequiredisOrgMarketMakerbooleanrequiredrolestringrequiredemploymentTypestring | nullrequiredrevokedAtstring | nullrequiredcreatedAtstringrequiredupdatedAtstringrequiredpayrollEmployeeIDstring | nullrequiredhasWelcomeEmailSentbooleanrequiredsubEmploymentTypestring | nullrequiredremarksstring | nullrequiredisITAdminbooleanrequiredisExternalEmployeebooleanrequiredemployeeSyncedSourcestring | nullrequiredinvestorFullNamestring | nullrequiredbaseSalarystring | nullrequiredAllowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$
baseSalaryCurrencystring | nullrequiredbaseSalaryPaymentTypestringrequiredbaseSalaryTokenTypeIDstring | nullrequiredbaseSalaryTokenSymbolstring | nullrequiredbaseSalaryTokenNetworkstring | nullrequiredbaseSalaryPeriodstring | nullrequiredstablecoinPayPercentagenumber | nullrequiredmaxStablecoinPercentagenumber | nullrequiredtaxMethodstring | nullrequiredwithholdingPercentagestring | nullrequiredAllowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$
lastLoginstring | nullrequiredlastTestTxReminderBystring | nullrequiredlastTestTxReminderAtstring | nullrequiredpayrollFileNumberstring | nullrequiredexternalPayrollIdstring | nullrequiredlastOnboardingReminderBystring | nullrequiredlastOnboardingReminderAtstring | nullrequiredaddressstring | nullrequiredpayrollGroupstring | nullrequiredlastInactiveWalletReminderBystring | nullrequiredlastInactiveWalletReminderAtstring | nullrequiredrecipientTypestring | nullrequiredreceiveNotificationEmailsbooleanrequiredreceiveInAppNotificationsbooleanrequirednotificationEmailFrequencystringrequiredreceiveSlackNotificationsbooleanrequiredselfServeContractorOnboardingStatusstringrequiredselfServeContractorOnboardingCompletedAtstring | nullrequiredselfServeWelcomeEmailSentAtstring | nullrequirednumberOfPayPeriodsPerYearintegerrequiredmanagerRoleInOrgIDstring | nullrequiredmanagerPathstring[]requiredpersonobjectrequiredShow child attributes
personIDstringrequiredgivenNamestringrequiredfamilyNamestringrequiredmiddleNamestring | nullrequiredcreatedAtstringrequiredupdatedAtstringrequiredlegacyMigratedAtstring | nullrequiredlegacyModelIDinteger | nullrequiredmergedIntoPersonIDstring | nullrequiredmergedAtstring | nullrequiredfullNamestringrequiredtotalPayableAmountnumberrequiredtotalPayableCurrencyCodeanyrequiredtotalPayableExchangeRatenumberrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits