Clients
Get Client by Id
Retrieves a client by its unique identifier.
GET
/
clients
/
{clientId}
Get Client by Id
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId} \
--header 'X-Auth-Token: <api-key>'{
"content": {
"data": {
"typeDiscriminator": "<string>",
"name": "<string>",
"organisationId": "<string>",
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>",
"id": "<string>",
"invoiceFormatTagGroup": "<string>",
"invoiceFormatTagName": "<string>",
"invoiceNumberTagGroup": "<string>",
"invoiceNumberTagName": "<string>",
"subtotalTagGroupName": "<string>",
"rebatePercentage": 123,
"vatNumber": "<string>",
"registrationNumber": "<string>",
"contacts": [
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"id": "<string>",
"phone": "<string>",
"role": "<string>",
"tags": [
{
"name": "<string>",
"group": "<string>",
"value": "<string>"
}
],
"includeInEmails": true
}
],
"tags": [
{
"name": "<string>",
"group": "<string>",
"value": "<string>"
}
],
"defaultRevenueAccountCode": "<string>",
"defaultTaxType": "<string>",
"providerId": "<string>",
"externalProvider": "<string>",
"lastSyncedAt": "<string>",
"syncErrorMessage": "<string>",
"billingAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"physicalAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"financeSettings": {
"defaultRevenueAccount": "<string>",
"defaultTaxRate": "<string>",
"payElementMappings": [
{
"payElementId": "<string>",
"accountCode": "<string>",
"taxType": "<string>"
}
],
"defaultDueDateDays": 123,
"defaultCurrencyCode": "<string>",
"defaultLineAmountTypes": "<string>",
"invoiceTemplateOverride": {
"showSubsectionHeader": true,
"showSubtotalInSubsection": true,
"showSubtotalVatInSubsection": true,
"showQuantitySumInSubsection": true,
"showBottomSubtotals": true,
"showVatInBottomSubtotals": true,
"showQuantitySumInBottomSubtotals": true,
"lineDescriptionFormula": "<string>",
"lineDescriptionTagGroupId": "<string>",
"includeAttachmentsWithOnlineInvoice": true
},
"creditNoteTemplateOverride": {
"showSubsectionHeader": true,
"showSubtotalInSubsection": true,
"showSubtotalVatInSubsection": true,
"showQuantitySumInSubsection": true,
"showBottomSubtotals": true,
"showVatInBottomSubtotals": true,
"showQuantitySumInBottomSubtotals": true,
"lineDescriptionFormula": "<string>",
"lineDescriptionTagGroupId": "<string>",
"includeAttachmentsWithOnlineInvoice": true
},
"invoiceReferenceFormula": "<string>",
"invoiceReferenceDateFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}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.
Was this page helpful?
⌘I
Get Client by Id
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId} \
--header 'X-Auth-Token: <api-key>'{
"content": {
"data": {
"typeDiscriminator": "<string>",
"name": "<string>",
"organisationId": "<string>",
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>",
"id": "<string>",
"invoiceFormatTagGroup": "<string>",
"invoiceFormatTagName": "<string>",
"invoiceNumberTagGroup": "<string>",
"invoiceNumberTagName": "<string>",
"subtotalTagGroupName": "<string>",
"rebatePercentage": 123,
"vatNumber": "<string>",
"registrationNumber": "<string>",
"contacts": [
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"id": "<string>",
"phone": "<string>",
"role": "<string>",
"tags": [
{
"name": "<string>",
"group": "<string>",
"value": "<string>"
}
],
"includeInEmails": true
}
],
"tags": [
{
"name": "<string>",
"group": "<string>",
"value": "<string>"
}
],
"defaultRevenueAccountCode": "<string>",
"defaultTaxType": "<string>",
"providerId": "<string>",
"externalProvider": "<string>",
"lastSyncedAt": "<string>",
"syncErrorMessage": "<string>",
"billingAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"physicalAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"financeSettings": {
"defaultRevenueAccount": "<string>",
"defaultTaxRate": "<string>",
"payElementMappings": [
{
"payElementId": "<string>",
"accountCode": "<string>",
"taxType": "<string>"
}
],
"defaultDueDateDays": 123,
"defaultCurrencyCode": "<string>",
"defaultLineAmountTypes": "<string>",
"invoiceTemplateOverride": {
"showSubsectionHeader": true,
"showSubtotalInSubsection": true,
"showSubtotalVatInSubsection": true,
"showQuantitySumInSubsection": true,
"showBottomSubtotals": true,
"showVatInBottomSubtotals": true,
"showQuantitySumInBottomSubtotals": true,
"lineDescriptionFormula": "<string>",
"lineDescriptionTagGroupId": "<string>",
"includeAttachmentsWithOnlineInvoice": true
},
"creditNoteTemplateOverride": {
"showSubsectionHeader": true,
"showSubtotalInSubsection": true,
"showSubtotalVatInSubsection": true,
"showQuantitySumInSubsection": true,
"showBottomSubtotals": true,
"showVatInBottomSubtotals": true,
"showQuantitySumInBottomSubtotals": true,
"lineDescriptionFormula": "<string>",
"lineDescriptionTagGroupId": "<string>",
"includeAttachmentsWithOnlineInvoice": true
},
"invoiceReferenceFormula": "<string>",
"invoiceReferenceDateFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}