Payment

GetPayrollsForCompany

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/companies/{companyUid}/payments

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"salary": 0,
"tax": 0,
"atp": 0,
"pensions": 0,
"holiday": 0,
"maternity": 0,
"holidayHourlyPaid": 0,
"holidayFixedPaid": 0,
"incomeAmount": 0,
"amContributionCalculated": 0,
"executedBy": "string",
"finishedDate": "2019-08-24T14:15:22Z",
"payrollType": 0,
"payrollNumber": 0,
"status": 1,
"activatedAt": "2019-08-24T14:15:22Z",
"numberOfEmployees": 0,
"extraPayrollRun": true,
"periodFrom": "2019-08-24T14:15:22Z",
"periodTo": "2019-08-24T14:15:22Z",
"dispositionDate": "2019-08-24T14:15:22Z",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

GetGroupedPaymentsAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version	string
filter.onlyFuture	boolean
filter.types	Array of integers <int32> Items Enum: 0 1 2 4 8 12 16 32 64 96 128 256 512 1024 2048 4096 8192 16384 16400 32768 65536 131072 206604 208654 262144 266304 524288
filter.status	Array of integers <int32> Items Enum: 0 1 2 3 4 5 6 7 8
filter.transferMode	Array of integers <int32> Items Enum: 1 2
filter.startDate	string <date-time>
filter.endDate	string <date-time>
filter.payrollUids	Array of strings <uuid>
filter.take	integer <int32>
filter.skip	integer <int32>

Responses

200

OK

get/api/companies/{companyUid}/payments/grouped

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"amount": 0,
"type": 0,
"status": 0,
"transferMode": 1,
"dispositionDate": "2019-08-24T14:15:22Z"
}
]
}

GetPaymentsForPayroll

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/companies/{companyUid}/payments/{payrollUid}

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"employee": {"incomeType": 0,
"holidayPayReceiverType": 0,
"extraHolidayEntitlementRule": "string",
"name": "string",
"employeeNumber": "string",
"extraEmployeeNumber": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"accFrom": "string",
"accTo": "string",
"amount": 0,
"type": 0,
"status": 0,
"transferMode": 1,
"dispositionDate": "2019-08-24T14:15:22Z",
"cvr": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

UpdatePaymentSegmentsStatusAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

Array

string <uuid>

Responses

204

No Content

patch/api/companies/{companyUid}/payments/{payrollUid}

Request samples

["00000000-0000-0000-0000-000000000000"
]

GetGroupedPaymentDetailsAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version	string
filter.onlyFuture	boolean
filter.type	integer <int32> Enum: 0 1 2 4 8 12 16 32 64 96 128 256 512 1024 2048 4096 8192 16384 16400 32768 65536 131072 206604 208654 262144 266304 524288
filter.status	integer <int32> Enum: 0 1 2 3 4 5 6 7 8
filter.transferMode	integer <int32> Enum: 1 2
filter.dispositionDate	string <date-time>
filter.payrollUids	Array of strings <uuid>
filter.take	integer <int32>
filter.skip	integer <int32>

Responses

200

OK

get/api/companies/{companyUid}/payments/grouped/details

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"payrollNumber": 0,
"createdOn": "2019-08-24T14:15:22Z",
"payrollUids": "00000000-0000-0000-0000-000000000000",
"amount": 0,
"type": 0,
"status": 0,
"transferMode": 1,
"dispositionDate": "2019-08-24T14:15:22Z"
}
]
}

GetCompanyGroupedPaymentsByDepartmentAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version	string
filter.onlyFuture	boolean
filter.type	integer <int32> Enum: 0 1 2 4 8 12 16 32 64 96 128 256 512 1024 2048 4096 8192 16384 16400 32768 65536 131072 206604 208654 262144 266304 524288
filter.status	integer <int32> Enum: 0 1 2 3 4 5 6 7 8
filter.transferMode	integer <int32> Enum: 1 2
filter.dispositionDate	string <date-time>
filter.payrollUids	Array of strings <uuid>
filter.take	integer <int32>
filter.skip	integer <int32>

Responses

200

OK

get/api/companies/{companyUid}/payments/grouped/department

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"amount": 0,
"type": 0,
"status": 0,
"transferMode": 1,
"dispositionDate": "2019-08-24T14:15:22Z",
"departmentUid": "00000000-0000-0000-0000-000000000000",
"departmentName": "string",
"departmentNumber": "string"
}
]
}

GetCompanyGroupedPaymentsByDepartmentDetailsAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version	string
filter.onlyFuture	boolean
filter.types	Array of integers <int32> Items Enum: 0 1 2 4 8 12 16 32 64 96 128 256 512 1024 2048 4096 8192 16384 16400 32768 65536 131072 206604 208654 262144 266304 524288
filter.status	Array of integers <int32> Items Enum: 0 1 2 3 4 5 6 7 8
filter.transferMode	Array of integers <int32> Items Enum: 1 2
filter.startDate	string <date-time>
filter.endDate	string <date-time>
filter.payrollUids	Array of strings <uuid>
filter.take	integer <int32>
filter.skip	integer <int32>

Responses

200

OK

get/api/companies/{companyUid}/payments/grouped/department/details

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"amount": 0,
"type": 0,
"status": 0,
"transferMode": 1,
"dispositionDate": "2019-08-24T14:15:22Z",
"departmentUid": "00000000-0000-0000-0000-000000000000",
"payrollNumber": 0,
"departmentName": "string",
"departmentNumber": "string",
"createdOn": "2019-08-24T14:15:22Z"
}
]
}

GetPaymentsForPayrollExportCsv

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>
bankExportType required	integer <int32> Enum: 1 2 3 4
transactionCost required	integer <int32> Enum: 1 2 3

query Parameters

api-version

string

Responses

200

OK

get/api/companies/{companyUid}/payments/{payrollUid}/export/{bankExportType}/{transactionCost}

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{ }

CreateCompanyBankAccountDeprecated

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

kontoNumber required	string [ 0 .. 10 ] characters
regNumber required	string [ 0 .. 4 ] characters
enableNetsPayment	boolean

Responses

200

OK

post/api/companies/{companyUid}/payments/agreements

Request samples

{"kontoNumber": "string",
"regNumber": "stri",
"enableNetsPayment": true
}

Response samples

200

{"accountNumber": "string",
"registrationNumber": "string",
"netsStatus": 0,
"applierName": "string",
"applierEmail": "string",
"applierContactPhone": "string",
"isApplierBaPowerOfAttorney": true,
"appliedOn": "2019-08-24T14:15:22Z",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}

GetGroupedPaymentsExportAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

Array

onlyFuture	boolean
type	integer <int32> Enum: 0 1 2 4 8 12 16 32 64 96 128 256 512 1024 2048 4096 8192 16384 16400 32768 65536 131072 206604 208654 262144 266304 524288
status	integer <int32> Enum: 0 1 2 3 4 5 6 7 8
transferMode	integer <int32> Enum: 1 2
dispositionDate	string <date-time>
payrollUids	Array of strings <uuid>
take	integer <int32>
skip	integer <int32>

Responses

200

OK

post/api/companies/{companyUid}/payments/grouped/export

Request samples

[{"onlyFuture": true,
"type": 0,
"status": 0,
"transferMode": 1,
"dispositionDate": "2019-08-24T14:15:22Z",
"payrollUids": ["00000000-0000-0000-0000-000000000000"
],
"take": 0,
"skip": 0
}
]

Response samples

200

{ }

UpdatePaymentsTransferModeAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

	Array of objects (Zalary.Models.Payment.PaymentSegmentsGroupedFilter)
toAction	integer <int32> Enum: 1 2
verificationCode required	string = 6 characters

Responses

204

No Content

patch/api/companies/{companyUid}/payments/grouped/transfer-mode

Request samples

{"paymentFilters": [{"onlyFuture": true,
"type": 0,
"status": 0,
"transferMode": 1,
"dispositionDate": "2019-08-24T14:15:22Z",
"payrollUids": ["00000000-0000-0000-0000-000000000000"
],
"take": 0,
"skip": 0
}
],
"toAction": 1,
"verificationCode": "string"
}

UpdatePaymentSegmentsStatusToManuallyPaidAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

Array

onlyFuture	boolean
type	integer <int32> Enum: 0 1 2 4 8 12 16 32 64 96 128 256 512 1024 2048 4096 8192 16384 16400 32768 65536 131072 206604 208654 262144 266304 524288
status	integer <int32> Enum: 0 1 2 3 4 5 6 7 8
transferMode	integer <int32> Enum: 1 2
dispositionDate	string <date-time>
payrollUids	Array of strings <uuid>
take	integer <int32>
skip	integer <int32>

Responses

204

No Content

patch/api/companies/{companyUid}/payments/grouped/update-status

Request samples

[{"onlyFuture": true,
"type": 0,
"status": 0,
"transferMode": 1,
"dispositionDate": "2019-08-24T14:15:22Z",
"payrollUids": ["00000000-0000-0000-0000-000000000000"
],
"take": 0,
"skip": 0
}
]

UpdatePaymentsDispositionDateAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

	Array of objects (Zalary.Models.Payment.PaymentSegmentsGroupedFilter)
dispositionDate required	string <date-time>
verificationCode required	string = 6 characters

Responses

204

No Content

patch/api/companies/{companyUid}/payments/grouped/disposition-date

Request samples

{"paymentFilters": [{"onlyFuture": true,
"type": 0,
"status": 0,
"transferMode": 1,
"dispositionDate": "2019-08-24T14:15:22Z",
"payrollUids": ["00000000-0000-0000-0000-000000000000"
],
"take": 0,
"skip": 0
}
],
"dispositionDate": "2019-08-24T14:15:22Z",
"verificationCode": "string"
}

UpdatePaymentSegmentsTransferModeAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

paymentSegmentUids	Array of strings <uuid>
toAction	integer <int32> Enum: 1 2
verificationCode required	string = 6 characters

Responses

204

No Content

patch/api/companies/{companyUid}/payments/{payrollUid}/transfer-mode

Request samples

{"paymentSegmentUids": ["00000000-0000-0000-0000-000000000000"
],
"toAction": 1,
"verificationCode": "string"
}

UpdatePaymentsTransferModeDetailsAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

	object (Zalary.Models.Payment.PaymentSegmentsGroupedFilter)
payrollNumbers	Array of integers <int32>
toAction	integer <int32> Enum: 1 2
verificationCode required	string = 6 characters

Responses

204

No Content

patch/api/companies/{companyUid}/payments/grouped/details/transfer-mode

Request samples

{"paymentFilter": {"onlyFuture": true,
"type": 0,
"status": 0,
"transferMode": 1,
"dispositionDate": "2019-08-24T14:15:22Z",
"payrollUids": ["00000000-0000-0000-0000-000000000000"
],
"take": 0,
"skip": 0
},
"payrollNumbers": [0
],
"toAction": 1,
"verificationCode": "string"
}

UpdatePaymentSegmentsDispositionDateAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

paymentSegmentUids	Array of strings <uuid>
dispositionDate	string <date-time>
transferMode	integer <int32> Enum: 1 2
paymentStatus	integer <int32> Enum: 0 1 2 3 4 5 6 7 8
verificationCode required	string = 6 characters

Responses

204

No Content

patch/api/companies/{companyUid}/payments/{payrollUid}/disposition-date

Request samples

{"paymentSegmentUids": ["00000000-0000-0000-0000-000000000000"
],
"dispositionDate": "2019-08-24T14:15:22Z",
"transferMode": 1,
"paymentStatus": 0,
"verificationCode": "string"
}

UpdatePaymentsDetailsDispositionDateAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

	object (Zalary.Models.Payment.PaymentSegmentsGroupedFilter)
payrollNumbers	Array of integers <int32>
dispositionDate required	string <date-time>
verificationCode required	string = 6 characters

Responses

204

No Content

patch/api/companies/{companyUid}/payments/grouped/details/disposition-date

Request samples

{"paymentFilter": {"onlyFuture": true,
"type": 0,
"status": 0,
"transferMode": 1,
"dispositionDate": "2019-08-24T14:15:22Z",
"payrollUids": ["00000000-0000-0000-0000-000000000000"
],
"take": 0,
"skip": 0
},
"payrollNumbers": [0
],
"dispositionDate": "2019-08-24T14:15:22Z",
"verificationCode": "string"
}

DeleteCompanyBankAccountDeprecated

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
paymentAgreementUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

delete/api/companies/{companyUid}/payments/agreements/{paymentAgreementUid}

Request samples

C#
Java
Python
JavaScript
curl

Payment

GetPayrollsForCompany

path Parameters

query Parameters

GetGroupedPaymentsAsync

path Parameters

query Parameters

GetPaymentsForPayroll

path Parameters

query Parameters

UpdatePaymentSegmentsStatusAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

GetGroupedPaymentDetailsAsync

path Parameters

query Parameters

GetCompanyGroupedPaymentsByDepartmentAsync

path Parameters

query Parameters

GetCompanyGroupedPaymentsByDepartmentDetailsAsync

path Parameters

query Parameters

GetPaymentsForPayrollExportCsv

path Parameters

query Parameters

CreateCompanyBankAccountDeprecated

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

GetGroupedPaymentsExportAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

UpdatePaymentsTransferModeAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

UpdatePaymentSegmentsStatusToManuallyPaidAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

UpdatePaymentsDispositionDateAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

UpdatePaymentSegmentsTransferModeAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

UpdatePaymentsTransferModeDetailsAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

UpdatePaymentSegmentsDispositionDateAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

UpdatePaymentsDetailsDispositionDateAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

DeleteCompanyBankAccountDeprecated

path Parameters

query Parameters

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json