Scopes used on this page: contractor:read. Calling an endpoint your key was not granted the scope for returns 403 insufficient_scope.
Every call below needs your API key — see Partner API: authentication and your first call — and every response follows the paging and field-selection rules in Partner API: pagination, field selection and identifiers.
GET /v1/contractor/payments
Contractor payment lines in a processed-on window, plus a per-contractor and per-currency rollup of the same lines. The window is required and bounded: pass period=current_month, or both processed_from and processed_to.
Scope required: contractor:read.
Query parameters:
period— Shorthand window. Supply this OR both processed_from and processed_to, never neither and never both. One of:current_month.processed_from— Start of the processed-on window, inclusive (YYYY-MM-DD).processed_to— End of the processed-on window, inclusive (YYYY-MM-DD).entity_id— Restrict to one legal entity.fields— Comma-separated subset of this endpoint's response fields, at most 100. Narrowing only: a name outside the documented field list is rejected with 400, never silently ignored.
The response comes back in sections rather than as one flat list:
Fields on each entry in
by_contractor:adjustments,basic,components,department,employee_id,entity_currency,full_name,gross_salary,net_salary,payroll_currency,reimbursements,special_allowance,total_outflow,work_email.Fields on each entry in
payments:adjustments,asan_empcode,basic,components,department,edli_gross_salary,employee_id,entity_currency,epf_admin_employer,epf_edli_employer,epf_employee,epf_gross_salary,eps_gross_salary,esi_employee,esi_employer,external_comment,from_date,full_name,gross_salary,invoice_id,net_salary,net_salary_before_tax,num_units,payment_method,payroll_currency,payroll_type,processed_on,professional_tax,reimbursements,special_allowance,status,tds_cess,tds_surcharge,to_date,total_outflow,work_email.
Example:
curl -s "https://api.asanify.com/v1/contractor/payments?period=current_month" \ -H "Authorization: Bearer $ASANIFY_API_KEY"