- Overview
- CompanyInvoice
- GetAgencyInvoicesGET
- Retrieves detailed information for a specific invoice.GET
- Retrieves a list of invoice overpayments for a given agency,
supporting pagination and cancellation.GET
- Retrieves a list of invoice credits (credit memos) for a given Agency, with support for pagination and cancellation.GET
- Manages (creates or updates) an invoice payment.POST
- GetGET
- Downloads the invoice PDF for the specified invoiceId.GET
- GetAgencyInvoices
- Accounting
- Schemas
- Schemas
- ProblemDetails
- BankType
- CheckFormat
- NACHAHeaderFile
- BankDto
- GLAccountType
- GlaccountDto_ToBeDeleted
- TaxFieldDto
- AlertsDto
- AuditActionEntity
- AuditActionType
- AuditLogViewDto
- InvoiceStatus
- InvoicePaymentDto
- BatchBillingViewDto
- SaveBatchBillingCommand
- DeleteBatchBillingCommand
- CloseBatchBillingCommand
- BatchBillingDetailDto
- InvoiceOverPaymentDto
- SaveBatchBillingDetailCommand
- UpdateBillingDetailCommand
- DeleteBatchBillingDetailCommand
- InvoiceClientOverPaymentDto
- Suffix
- ClientStatus
- AddressType
- State
- Country
- AddressDto
- GroupInvoiceType
- PayCategoryMappingDto
- PayCategoryTemplateDto
- LeftLogoType
- RightLogoType
- Address1Type
- Address2Type
- InvoiceViewType
- Address1TypeAddr
- Address2TypeAddr
- Address3Type
- Address3TypeAddr
- PayPeriodFormat
- CustomInvoiceTemplateDto
- FeeType
- InvoiceItemType
- ClientInvoiceFeeSetupDto
- LateFeeType
- ClientInvoiceLateFeeSetupDto
- ClientInvoiceSetupDto
- ClientBranchAssignDto
- ClientDepartmentDto
- ClientLevelDto
- ClientShiftAsgmtDto
- ClientDetailedViewDto
- SaveClientCommand
- PayDataClientEmployeeDto
- ClientTemplateDetailDto
- ClientInvoiceUpdateDto
- UpdateClientInvoiceTemplateCommand
- DeleteClientCommand
- SaveClientDepartmentCommand
- DeleteClientDepartmentCommand
- ClientLevelTypeDto
- SaveClientOrgStructureCommand
- SaveClientLevelCommand
- ClientLevelDropdownDto
- DeleteClientLevelCommand
- ClientCreditMemoDto
- ClientCreditMemoDetailDto
- SaveClientCreditMemoCommand
- RefundCreditMemoCommand
- DeleteClientCreditMemoCommand
- CreditMemoStatus
- ManageCreditMemoStatusCommand
- FileDataDto
- EmailClientCreditMemoCommand
- ProfileStatus
- AccrualCalcMethod
- AccrualDecrementWageType
- AccrualAnnualPeriod
- AccrualRollover
- AccrualFrequency
- AccrualIncrementWageType
- AccrualIncrementCodeDto
- AccrualRateDto
- AccrualDto
- AdvanceCalcMethod
- AdvanceFrequency
- AdvanceDto
- AutoBreakGroupDto
- BankTransmissionDeadline
- CompanyBankDto
- CompanyBankingSettingDto
- HolidayName
- CompanyHolidayDto
- CompanyTaxDestination
- CompanyTaxDueFrequency
- CompanyTaxDto
- CompanyUnpaidHolidayTypeDto
- DeductionCalcMethod
- DeductionFrequency
- PrePostTax
- VendorType
- VendorPayFrequency
- VendorPayMethod
- CompanyVendorDetailedDto
- SymmetryBenefit
- DeductionDto
- TaxGroupTaxDto
- TaxGroupDto
- DepartmentDto
- LocationDto
- DivisionDto
- BranchDto
- RegionDto
- CompanyFeeSetupDto
- PayCategoryCode
- PayCatType
- PayHrsType
- PayCategoryDto
- PayFrequency
- WeekBegins
- HolidayRule
- PayrollGroupDto
- ReimbursementCalcMethod
- ReimbursementFrequency
- ReimbursementDto
- DifferentialType
- DepartmentShiftDto
- CompanyShiftDto
- CompanySutaRateDto
- TFBCalcMethod
- TFBFrequency
- TfbDto
- CompanyEEOClassificationDto
- CustomTemplateType
- CustomTemplateDto
- CompanySettingDto
- Esc550ConfigDto
- CompanyNetTermDto
- CompanyDetailedViewDto
- SaveCompanyCommand
- CompanyInclude
- Int32StringValueTuple
- EmployeeLoginDto
- CompanyBankAccountNumberDto
- TaxType
- TaxBasicDto
- CompanyVendorDto
- GarnishmentCalcMethod
- GarnishmentFrequency
- GarnishmentType
- GarnishmentDto
- JobTitleDto
- CompanyJobsDto
- OrganizationForDropdownDto
- CompanyJobClassesDto
- EmployeeStatus
- PayType
- HeadCountDto
- CustomLabelDto
- FPCompanySettingDto
- InvoicePayPeriodDto
- FundingProviderDto
- InvoiceDto
- FPCompanySettingReqDto
- SyncInvoiceAddressDto
- SyncInvoiceRecordDto
- SyncInvoiceExpenseDto
- SyncInvoiceTaxDto
- SyncInvoicePaymentDto
- InvoiceDetailsDto
- InvoiceOverPaymentsDto
- InvoiceCreditDto
- ManageInvoicePaymentCommand
- ELGChangeDto
- RejectedComments
- ELGChangeResDto
- Prefix
- WorkStatus
- Gender
- EEOJobCategory
- RaceEthnicity
- Category
- PayrollDataStatus
- TerminationReason
- EmployeeAccrualDto
- ClientEmpLevelMappingDto
- ClientEmpDeptMappingDto
- EmployeeClientAssignmentDto
- EmployeeAdvanceDto
- EmployeeDeductionDto
- EmployeeDepartmentDto
- AccountType
- DirectDepositCalcMethod
- EmployeeDirectDepositDto
- EmployeeFederalTaxSetupDto
- EmployeeGarnishmentDto
- EmployeeHireDateDto
- EmployeePayRateDto
- EmployeeReimbursementDto
- EmployeeStateAndLocalTaxSetupDto
- EmployeeStatusDto
- EmployeeTfbDto
- PayAllocationDto
- EmployeeBranchAsgmtDto
- NewEmployeeAdjustmentYtdDto
- NewEmployeeTaxYtdDto
- EmployeeDetailedViewDto
- SaveEmployeeCommand
- DeleteEmployeeCommand
- SaveEmployeeAssignmentCommand
- EmployeeDirectDepositBasicDto
- EmployeeStateLocalTaxDetailDto
- PayDataEmployeeGarnishmentsDto
- PayrollType
- PayrollBatchDto
- PayrollDto
- CompanySettingGridViewDto
- CompanyGridViewDto
- GlReportDto
- GlAccountsDto
- GlAccountTypeDto
- SubTaxType
- TaxDto
- TaxIdsContainerDto
- AuditEventType
- AuditDto
- FilingStatusDto
- OvertimeGroupDto
- NaicDto
- PeriodDateV2FilterDto
- PeriodDatesDto
- SemiMonthlyPeriodDateFilterDto
- SemiMonthlyPeriodDateDto
- CompensationCodesDto
- EmployeeGridViewDto
- ReportType
- TaxFormGridViewDto
- TaxPaymentTaxDto
- TaxPaymentGridViewDto
- ClientGridViewDto
- PaymentType
- PaymentStatus
- NachaPaymentGridViewDto
- PayrollGridViewDto
- VoidPayrollEmployeeDto
- CheckType
- CheckStatus
- ChecksGridViewDto
- EmployeeChecksGridViewDto
- PrintStatus
- VendorChecksGridViewDto
- AdjustmentType
- UserGridViewDto
- GroupsGridViewDto
- SecurityObject
- SecurityAction
- ClientAssignmentsGridViewDto
- ClientAssignmentsGridViewFilterDto
- OrganizationGridViewDto
- InvoiceMailStatus
- InvoicePayrollInfoDto
- AdjInvoiceType
- InvoicesGridViewDto
- BatchBillingGridViewDto
- BatchBillingDetailGridViewDto
- EmployeeEmailStubGridViewDto
- PageSecurityObject
- ImageDto
- CreditMemoDocDto
- ImportPayrollDto
- ImportPayrollCommand
- RejectedPayrollComments
- ImportPayrollResDto
- ImportPayrollColumnDto
- ImportPayrollFileLogDto
- InvoiceMethod
- BillRateType
- InvoiceRecordDto
- EmployeeInvoiceDto
- ConsolidatedEmployeeInvoiceDto
- InvoiceExpenseRateType
- InvoiceExpenseDto
- InvoiceTaxType
- InvoiceTaxDto
- InvoiceCreditMemoDto
- InvoiceAdjustmentApproverDto
- AdjustmentApprovalStatus
- InvoiceAdjustmentApprovalDto
- SaveInvoiceCommand
- InvoiceDetailedViewDto
- InvoiceInfoDto
- InvoiceCustomerInfo
- InvoiceBulkDetailViewDto
- InvoiceBulkViewDto
- InvoiceRecordAdjDto
- InvoiceExpenseAdjDto
- InvoiceTaxAdjDto
- InvoiceAdjustmentDetailViewDto
- SaveAdjustmentInvoiceCommand
- RejectInvoiceAdjustmentCommand
- PostInvoiceCommand
- AdjInvoiceCommand
- MarkAsPaidCommand
- Dashboard_GridDto
- InvoicesDashboardDto
- WageType
- BillableChargeWageDto
- DeleteInvoicePaymentCommand
- InvoiceEmailHistoryDto
- InvoiceAdjApprovalUserDto
- InvoiceSummaryDto
- SettingFor
- KendoGridSettingDto
- OrganizationDetailViewDto
- SaveOrganizationCommand
- PayrollsForAuditDto
- ListSortDirection
- MemberTypes
- ParameterAttributes
- MethodAttributes
- MethodImplAttributes
- CallingConventions
- IntPtr
- RuntimeMethodHandle
- ModuleHandle
- CustomAttributeTypedArgument
- CustomAttributeNamedArgument
- CustomAttributeData
- Module
- ConstructorInfo
- EventAttributes
- EventInfo
- FieldAttributes
- RuntimeFieldHandle
- FieldInfo
- PropertyAttributes
- PropertyInfo
- MethodBase
- GenericParameterAttributes
- TypeAttributes
- LayoutKind
- StructLayoutAttribute
- RuntimeTypeHandle
- TypeInfo
- SecurityRuleSet
- Assembly
- Type
- MemberInfo
- ParameterInfo
- ICustomAttributeProvider
- MethodInfo
- ObjectObjectFunc
- ClientHandlerDescriptor
- SortDescriptor
- IFilterDescriptor
- AggregateFunction
- GroupDescriptor
- AggregateDescriptor
- DataSourceRequest
- PayDataAccrualDto
- PayDataAdvanceDto
- PayDataDeductionDto
- EarningType
- PayDataEarningDto
- PayDataGarnishmentDto
- PayDataHourDto
- PayDataReimbursementDto
- PayDataTfbDto
- PayDataTaxOverrideDto
- PayDataTLMDto
- PayDataTlmAccrualDto
- PayDataTlmWorkerCompCodeDto
- PayDataEntryDto
- PayDataGridColumnDto
- SavePayDataEntriesCommand
- PayrollDashboardDataDto
- PayrollAdjustmentAggregateDto
- PayrollTaxAggregateDto
- PayrollHoursEarningsDto
- TLMPayCategoryType
- PayCategory
- BillRateTypes
- PayrollStatus
- PayrollWage
- AccrualEventType
- AccrualEntryType
- AccrualTransaction
- PayrollTFB
- PayrollAdvance
- PayrollReimbursement
- PayrollGarnishment
- PayrollDeduction
- TaxStatus
- PayrollFederalTaxSetup
- PayrollStateAndLocalTaxSetup
- PayrollTax
- PayrollDirectDeposit
- TaxShortfall
- AdjustmentShortfall
- TaxCollection
- PayrollTlmWorkerCompCodeRecord
- PayrollRecord
- EmployeeBasicDto
- ObjectBasicInfoDto
- ProcessedPayrollDto
- GetPayrollPreviewQuery
- PayrollBasicInfoDto
- PayrollRecordType
- PayrollAdvanceDto
- PayrollDeductionDto
- PayrollGarnishmentDto
- PayrollReimbursementDto
- PayrollWageDto
- PayrollTaxDto
- PayrollDirectDepositDto
- PayrollTfbDto
- PayrollRecordDto
- ManualPayrollDto
- VoidPayrollDataCountDto
- VoidReason
- EmployeeDepartmentRateDto
- EmployeeDepartmentForPayDataDto
- ImportTimecardsIntoPaydataCommand
- RejectTimecardsCommand
- TimecardImportStatus
- TimecardAmountDto
- TimecardCompCodeDto
- TimecardDto
- Emp
- Wage
- Eetax
- AggregateResult
- Alltax
- DataSourceResult
- Ertax
- PayCategoryHoursDto
- Adjustment
- TimecardGridSummaryDto
- PayrollRec
- TimecardGridResponseDto
- PayrollDataReportDto
- EmployeeShortInfoDto
- EmployeeApprovalPayRateValidationDto
- EmployeeOutOfStateValidationDto
- EmployeeApprovalValidationDto
- EmployeePayDataMismatchDto
- PayrollValidationApprovalDto
- AddEmployeesToPayrollCommand
- EmailPayStubValidationDto
- PayrollHistory
- PayrollHistoryResponse
- EmployeeCheckMobileDto
- EmployeeCheckMobileDtoResponse
- PayrollEarningDto
- PayrollAdjustmentDto
- PayrollRecordAggregatesDto
- PayrollRecordAggregatesDtoResponse
- ReportPayrollDialogDto
- ReportDialogYearDto
- ReportPayrollsDto
- ReportEmployeeDialogDto
- ReportEmployeesDto
- ReportEmployeeCheckDialogDto
- ReportAccrualDto
- AccrualTransactionsDialogDataDto
- PayrollDetailsReportDto
- PayrollSummaryDS2Dto
- PayrollSummaryTaxDto
- PayrollSummaryDS1Dto
- PayrollSummaryDto
- CustomTaxLiabilitySummaryReportDto
- TaxLiabilitySummaryReportDto
- AdjustmentReportDto
- AdjustmentDataDto
- AccrualDataDto
- TaxPaymentInfo
- TaxPaymentReportDto
- TaxPaymentDataDto
- AccrualTransactionsDataDto
- I9Dto
- W4Dto
- WorkersCompDto
- WorkersCompReportDto
- PayrollBasicViewDto
- UpcomingPayrollsReportDto
- TaxBasicViewDto
- TaxBreakdownDto
- PayrollTaxesOverviewReportDto
- AffordableCareActDataDto
- AffordableCareActReportDto
- GarnishmentReportDto
- ReportDto
- PRDEDDataDto
- ESC5500BronzeFileDto
- ClarusWotcReportDto
- QuarterlyEmployeesSUIDto
- QuarterlyEmployeesTaxableWageDto
- StatesDataDto
- FederalEeoReportDto
- UserGroupCompanyDto
- UserGroupDto
- UserRoleDto
- UserDto
- SaveUserCommand
- SaveUserProfileCommand
- HierarchyLevel
- RoleDto
- SaveRoleCommand
- RoleCountsDto
- GroupDetailedViewDto
- SaveGroupCommand
- SyncGetWurknowUserPermissionQuery
- SyncWurknowUserPermissionDto
- ErrorCodeDto
- LocationCodeDto
- SyncAddressDto
- SyncClientEmpLevelMappingDto
- SyncEmployeeClientAssignmentDto
- SyncEmployeeBranchAsgmtDto
- SyncEmployeePayRateDto
- SyncEmployeeCommand
- SyncBranchesDto
- SyncRegionsDto
- SyncPayrollGroupDto
- SyncPayCategoryDto
- SyncRecordRoleDto
- SyncOrganizationCommand
- SyncCompanyCommand
- SyncClientInvoiceSetupDto
- SyncClientBranchAssignDto
- SyncClientDepartmentDto
- SyncClientLevelDto
- SyncClientRoleDto
- SyncClientCommand
- SyncClientOpenInvoiceAmountCommand
- SyncClientDepartmentCommand
- SyncClientLevelCommand
- SyncClientShiftAsgmtDto
- SyncAllTlmShiftDto
- SyncTlmShiftCommand
- SyncClientShiftAsgmtCommand
- SyncClientRoleCommand
- SyncEmployeeStateAndLocalTaxSetupDto
- SyncEmployeeFederalTaxSetupDto
- SyncEmployeeDirectDepositDto
- SyncEmployeeProfileCommand
- SyncCompanyEEOClassificationCommand
- GetSyncVendorsQuery
- SyncCompanyVendorCommand
- GetSyncGarnishmentsQuery
- SyncEmployeeGarnishmentCommand
- SyncSystemSettingCommand
- SyncGetRolesQuery
- SyncUserCommand
- SyncGetUserRoleQuery
- SyncUserRoleDto
- SyncUserPermissionQuery
- SyncUserPermissionDto
- SystemSettingDto
- F940ScheduleADto
- F940Dto
- F941Dto
- Form941NDto
- FCADE9Dto
- CADE9CEmployeeDto
- SCADE9CDto
- FW2SummaryDto
- FW2box12DetailDto
- FW2box14DetailDto
- FW2localDetailDto
- FW2stateDetailDto
- FW2Dto
- PaymentTaxType
- CreateTaxPaymentCommand
- DueTaxPaymentDto
- TimecardGridDto
- Paycodes
- PayrollAccrual
- EmployeeAssignment
- TimecardImportCommand
- UpdateNotesCommand
- GetVendorPaymentDetailsQuery
- VendorPaymentDetailsDto
Get
Develop Env
http://localhost:5010
Develop Env
http://localhost:5010
GET
/api/v{version}/Agency
Request
Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************or
Path Params
Responses
🟢200OK
This response does not have a body.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://localhost:5010/api/v/Agency' \
--header 'Authorization: <api-key>'Modified at 2025-12-25 01:57:12