Organisation
Get the HMRC settings for the current organisation
Retrieves the HMRC settings for the current organisation
GET
/
organisation
/
hmrc
/
settings
Get the HMRC settings for the current organisation
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/organisation/hmrc/settings \
--header 'X-Auth-Token: <api-key>'{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>",
"data": {
"taxReferenceNumbers": {
"employerPayeReference": {
"officeNumber": "123",
"referenceNumber": "AB12345"
},
"accountsOfficeReference": "123PX00123456",
"selfAssessmentUniqueTaxpayerReference": "1234567890",
"corporationTaxReferenceUniqueTaxpayerReference": "1234567890"
},
"isCisContractor": false,
"hasSmallEmployerRelief": false,
"governmentGatewaySettings": {
"hmrcSubmissionMethod": "Direct",
"credentials": {
"userId": "user123",
"hasPassword": true,
"password": "***"
},
"agentCredentials": {
"userId": "user123",
"hasPassword": true,
"password": "***",
"agentId": "agent_123"
}
},
"organisationId": "org_123",
"createdDate": "2025-01-01T00:00:00Z",
"createdBy": "user_123",
"updatedBy": "user_456",
"updatedDate": "2025-01-02T00:00:00Z",
"employmentAllowanceSettings": {
"isEnabled": true,
"claimStatus": "Claimed",
"deMinimisStateAidSectors": [
"Agriculture",
"Industry"
]
},
"apprenticeshipLevySettings": {
"isEnabled": true,
"annualAllowanceAmount": 15000
},
"payeLiabilitySettings": {
"payFrequency": "Monthly"
},
"bankAccount": {
"accountNumber": "12345678",
"sortCode": "12-34-56",
"accountHolderName": "Acme Corporation Limited",
"buildingSocietyReference": "BS123456"
}
}
}Documentation Index
Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Access token obtained from OAuth2 client credentials flow
Was this page helpful?
Get multiple organisation information
Previous
Update the HMRC settings for the current organisation
Next
⌘I
Get the HMRC settings for the current organisation
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/organisation/hmrc/settings \
--header 'X-Auth-Token: <api-key>'{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>",
"data": {
"taxReferenceNumbers": {
"employerPayeReference": {
"officeNumber": "123",
"referenceNumber": "AB12345"
},
"accountsOfficeReference": "123PX00123456",
"selfAssessmentUniqueTaxpayerReference": "1234567890",
"corporationTaxReferenceUniqueTaxpayerReference": "1234567890"
},
"isCisContractor": false,
"hasSmallEmployerRelief": false,
"governmentGatewaySettings": {
"hmrcSubmissionMethod": "Direct",
"credentials": {
"userId": "user123",
"hasPassword": true,
"password": "***"
},
"agentCredentials": {
"userId": "user123",
"hasPassword": true,
"password": "***",
"agentId": "agent_123"
}
},
"organisationId": "org_123",
"createdDate": "2025-01-01T00:00:00Z",
"createdBy": "user_123",
"updatedBy": "user_456",
"updatedDate": "2025-01-02T00:00:00Z",
"employmentAllowanceSettings": {
"isEnabled": true,
"claimStatus": "Claimed",
"deMinimisStateAidSectors": [
"Agriculture",
"Industry"
]
},
"apprenticeshipLevySettings": {
"isEnabled": true,
"annualAllowanceAmount": 15000
},
"payeLiabilitySettings": {
"payFrequency": "Monthly"
},
"bankAccount": {
"accountNumber": "12345678",
"sortCode": "12-34-56",
"accountHolderName": "Acme Corporation Limited",
"buildingSocietyReference": "BS123456"
}
}
}