Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'fields', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'fieldset', 'basic'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sort', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'page', 1
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'per_page', 5
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'q', '<string>'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api-v2.fattureincloud.it/c/:company_id/entities/clients', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "current_page": "<integer>",
-- "first_page_url": "<uri>",
-- "from": "<integer>",
-- "last_page": "<integer>",
-- "last_page_url": "<uri>",
-- "next_page_url": "<uri>",
-- "path": "<uri>",
-- "per_page": "<integer>",
-- "prev_page_url": "<uri>",
-- "to": "<integer>",
-- "total": "<integer>",
-- "data": [
-- {
-- "id": "<integer>",
-- "code": "<string>",
-- "name": "<string>",
-- "type": null,
-- "first_name": "<string>",
-- "last_name": "<string>",
-- "contact_person": "<string>",
-- "vat_number": "<string>",
-- "tax_code": "<string>",
-- "address_street": "<string>",
-- "address_postal_code": "<string>",
-- "address_city": "<string>",
-- "address_province": "<string>",
-- "address_extra": "<string>",
-- "country": "<string>",
-- "email": "<string>",
-- "certified_email": "<string>",
-- "phone": "<string>",
-- "fax": "<string>",
-- "notes": "<string>",
-- "default_vat": {
-- "id": "<integer>",
-- "value": "<number>",
-- "description": "<string>",
-- "notes": "<string>",
-- "e_invoice": "<boolean>",
-- "ei_type": "<string>",
-- "ei_description": "<string>",
-- "editable": "<boolean>",
-- "is_disabled": "<boolean>"
-- },
-- "default_payment_terms": "<integer>",
-- "default_payment_terms_type": "standard",
-- "default_payment_method": {
-- "id": "<integer>",
-- "name": "<string>",
-- "type": "standard",
-- "is_default": "<boolean>",
-- "default_payment_account": {
-- "id": "<integer>",
-- "name": "<string>",
-- "type": "standard",
-- "iban": "<string>",
-- "sia": "<string>",
-- "cuc": "<string>",
-- "virtual": "<boolean>"
-- },
-- "details": [
-- {
-- "title": "<string>",
-- "description": "<string>"
-- },
-- {
-- "title": "<string>",
-- "description": "<string>"
-- }
-- ],
-- "bank_iban": "<string>",
-- "bank_name": "<string>",
-- "bank_beneficiary": "<string>",
-- "ei_payment_method": "<string>"
-- },
-- "bank_name": "<string>",
-- "bank_iban": "<string>",
-- "bank_swift_code": "<string>",
-- "shipping_address": "<string>",
-- "e_invoice": "<boolean>",
-- "ei_code": "<string>",
-- "discount_highlight": "<boolean>",
-- "default_discount": "<number>",
-- "has_intent_declaration": "<boolean>",
-- "intent_declaration_protocol_number": "<string>",
-- "intent_declaration_protocol_date": "<date>",
-- "created_at": "<string>",
-- "updated_at": "<string>"
-- },
-- {
-- "id": "<integer>",
-- "code": "<string>",
-- "name": "<string>",
-- "type": null,
-- "first_name": "<string>",
-- "last_name": "<string>",
-- "contact_person": "<string>",
-- "vat_number": "<string>",
-- "tax_code": "<string>",
-- "address_street": "<string>",
-- "address_postal_code": "<string>",
-- "address_city": "<string>",
-- "address_province": "<string>",
-- "address_extra": "<string>",
-- "country": "<string>",
-- "email": "<string>",
-- "certified_email": "<string>",
-- "phone": "<string>",
-- "fax": "<string>",
-- "notes": "<string>",
-- "default_vat": {
-- "id": "<integer>",
-- "value": "<number>",
-- "description": "<string>",
-- "notes": "<string>",
-- "e_invoice": "<boolean>",
-- "ei_type": "<string>",
-- "ei_description": "<string>",
-- "editable": "<boolean>",
-- "is_disabled": "<boolean>"
-- },
-- "default_payment_terms": "<integer>",
-- "default_payment_terms_type": "standard",
-- "default_payment_method": {
-- "id": "<integer>",
-- "name": "<string>",
-- "type": "standard",
-- "is_default": "<boolean>",
-- "default_payment_account": {
-- "id": "<integer>",
-- "name": "<string>",
-- "type": "standard",
-- "iban": "<string>",
-- "sia": "<string>",
-- "cuc": "<string>",
-- "virtual": "<boolean>"
-- },
-- "details": [
-- {
-- "title": "<string>",
-- "description": "<string>"
-- },
-- {
-- "title": "<string>",
-- "description": "<string>"
-- }
-- ],
-- "bank_iban": "<string>",
-- "bank_name": "<string>",
-- "bank_beneficiary": "<string>",
-- "ei_payment_method": "<string>"
-- },
-- "bank_name": "<string>",
-- "bank_iban": "<string>",
-- "bank_swift_code": "<string>",
-- "shipping_address": "<string>",
-- "e_invoice": "<boolean>",
-- "ei_code": "<string>",
-- "discount_highlight": "<boolean>",
-- "default_discount": "<number>",
-- "has_intent_declaration": "<boolean>",
-- "intent_declaration_protocol_number": "<string>",
-- "intent_declaration_protocol_date": "<date>",
-- "created_at": "<string>",
-- "updated_at": "<string>"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @id nvarchar(4000)
DECLARE @code nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @first_name nvarchar(4000)
DECLARE @last_name nvarchar(4000)
DECLARE @contact_person nvarchar(4000)
DECLARE @vat_number nvarchar(4000)
DECLARE @tax_code nvarchar(4000)
DECLARE @address_street nvarchar(4000)
DECLARE @address_postal_code nvarchar(4000)
DECLARE @address_city nvarchar(4000)
DECLARE @address_province nvarchar(4000)
DECLARE @address_extra nvarchar(4000)
DECLARE @country nvarchar(4000)
DECLARE @email nvarchar(4000)
DECLARE @certified_email nvarchar(4000)
DECLARE @phone nvarchar(4000)
DECLARE @fax nvarchar(4000)
DECLARE @notes nvarchar(4000)
DECLARE @Id nvarchar(4000)
DECLARE @Value nvarchar(4000)
DECLARE @Description nvarchar(4000)
DECLARE @Notes nvarchar(4000)
DECLARE @E_invoice nvarchar(4000)
DECLARE @Ei_type nvarchar(4000)
DECLARE @Ei_description nvarchar(4000)
DECLARE @Editable nvarchar(4000)
DECLARE @Is_disabled nvarchar(4000)
DECLARE @default_payment_terms nvarchar(4000)
DECLARE @default_payment_terms_type nvarchar(4000)
DECLARE @default_payment_methodId nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @v_Type nvarchar(4000)
DECLARE @Is_default nvarchar(4000)
DECLARE @Default_payment_accountId nvarchar(4000)
DECLARE @Default_payment_accountName nvarchar(4000)
DECLARE @Default_payment_accountType nvarchar(4000)
DECLARE @Iban nvarchar(4000)
DECLARE @Sia nvarchar(4000)
DECLARE @Cuc nvarchar(4000)
DECLARE @v_Virtual nvarchar(4000)
DECLARE @Bank_iban nvarchar(4000)
DECLARE @Bank_name nvarchar(4000)
DECLARE @Bank_beneficiary nvarchar(4000)
DECLARE @Ei_payment_method nvarchar(4000)
DECLARE @bank_name nvarchar(4000)
DECLARE @bank_iban nvarchar(4000)
DECLARE @bank_swift_code nvarchar(4000)
DECLARE @shipping_address nvarchar(4000)
DECLARE @e_invoice nvarchar(4000)
DECLARE @ei_code nvarchar(4000)
DECLARE @discount_highlight nvarchar(4000)
DECLARE @default_discount nvarchar(4000)
DECLARE @has_intent_declaration nvarchar(4000)
DECLARE @intent_declaration_protocol_number nvarchar(4000)
DECLARE @intent_declaration_protocol_date nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @title nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @current_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @current_page OUT, 'current_page'
DECLARE @first_page_url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @first_page_url OUT, 'first_page_url'
DECLARE @from nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @from OUT, 'from'
DECLARE @last_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @last_page OUT, 'last_page'
DECLARE @last_page_url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @last_page_url OUT, 'last_page_url'
DECLARE @next_page_url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @next_page_url OUT, 'next_page_url'
DECLARE @path nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @path OUT, 'path'
DECLARE @per_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @per_page OUT, 'per_page'
DECLARE @prev_page_url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @prev_page_url OUT, 'prev_page_url'
DECLARE @v_to nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_to OUT, 'to'
DECLARE @total nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @total OUT, 'total'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @code OUT, 'data[i].code'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'data[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'data[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @first_name OUT, 'data[i].first_name'
EXEC sp_OAMethod @jResp, 'StringOf', @last_name OUT, 'data[i].last_name'
EXEC sp_OAMethod @jResp, 'StringOf', @contact_person OUT, 'data[i].contact_person'
EXEC sp_OAMethod @jResp, 'StringOf', @vat_number OUT, 'data[i].vat_number'
EXEC sp_OAMethod @jResp, 'StringOf', @tax_code OUT, 'data[i].tax_code'
EXEC sp_OAMethod @jResp, 'StringOf', @address_street OUT, 'data[i].address_street'
EXEC sp_OAMethod @jResp, 'StringOf', @address_postal_code OUT, 'data[i].address_postal_code'
EXEC sp_OAMethod @jResp, 'StringOf', @address_city OUT, 'data[i].address_city'
EXEC sp_OAMethod @jResp, 'StringOf', @address_province OUT, 'data[i].address_province'
EXEC sp_OAMethod @jResp, 'StringOf', @address_extra OUT, 'data[i].address_extra'
EXEC sp_OAMethod @jResp, 'StringOf', @country OUT, 'data[i].country'
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'data[i].email'
EXEC sp_OAMethod @jResp, 'StringOf', @certified_email OUT, 'data[i].certified_email'
EXEC sp_OAMethod @jResp, 'StringOf', @phone OUT, 'data[i].phone'
EXEC sp_OAMethod @jResp, 'StringOf', @fax OUT, 'data[i].fax'
EXEC sp_OAMethod @jResp, 'StringOf', @notes OUT, 'data[i].notes'
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data[i].default_vat.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'data[i].default_vat.value'
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'data[i].default_vat.description'
EXEC sp_OAMethod @jResp, 'StringOf', @Notes OUT, 'data[i].default_vat.notes'
EXEC sp_OAMethod @jResp, 'StringOf', @E_invoice OUT, 'data[i].default_vat.e_invoice'
EXEC sp_OAMethod @jResp, 'StringOf', @Ei_type OUT, 'data[i].default_vat.ei_type'
EXEC sp_OAMethod @jResp, 'StringOf', @Ei_description OUT, 'data[i].default_vat.ei_description'
EXEC sp_OAMethod @jResp, 'StringOf', @Editable OUT, 'data[i].default_vat.editable'
EXEC sp_OAMethod @jResp, 'StringOf', @Is_disabled OUT, 'data[i].default_vat.is_disabled'
EXEC sp_OAMethod @jResp, 'StringOf', @default_payment_terms OUT, 'data[i].default_payment_terms'
EXEC sp_OAMethod @jResp, 'StringOf', @default_payment_terms_type OUT, 'data[i].default_payment_terms_type'
EXEC sp_OAMethod @jResp, 'StringOf', @default_payment_methodId OUT, 'data[i].default_payment_method.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'data[i].default_payment_method.name'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'data[i].default_payment_method.type'
EXEC sp_OAMethod @jResp, 'StringOf', @Is_default OUT, 'data[i].default_payment_method.is_default'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_payment_accountId OUT, 'data[i].default_payment_method.default_payment_account.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_payment_accountName OUT, 'data[i].default_payment_method.default_payment_account.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_payment_accountType OUT, 'data[i].default_payment_method.default_payment_account.type'
EXEC sp_OAMethod @jResp, 'StringOf', @Iban OUT, 'data[i].default_payment_method.default_payment_account.iban'
EXEC sp_OAMethod @jResp, 'StringOf', @Sia OUT, 'data[i].default_payment_method.default_payment_account.sia'
EXEC sp_OAMethod @jResp, 'StringOf', @Cuc OUT, 'data[i].default_payment_method.default_payment_account.cuc'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Virtual OUT, 'data[i].default_payment_method.default_payment_account.virtual'
EXEC sp_OAMethod @jResp, 'StringOf', @Bank_iban OUT, 'data[i].default_payment_method.bank_iban'
EXEC sp_OAMethod @jResp, 'StringOf', @Bank_name OUT, 'data[i].default_payment_method.bank_name'
EXEC sp_OAMethod @jResp, 'StringOf', @Bank_beneficiary OUT, 'data[i].default_payment_method.bank_beneficiary'
EXEC sp_OAMethod @jResp, 'StringOf', @Ei_payment_method OUT, 'data[i].default_payment_method.ei_payment_method'
EXEC sp_OAMethod @jResp, 'StringOf', @bank_name OUT, 'data[i].bank_name'
EXEC sp_OAMethod @jResp, 'StringOf', @bank_iban OUT, 'data[i].bank_iban'
EXEC sp_OAMethod @jResp, 'StringOf', @bank_swift_code OUT, 'data[i].bank_swift_code'
EXEC sp_OAMethod @jResp, 'StringOf', @shipping_address OUT, 'data[i].shipping_address'
EXEC sp_OAMethod @jResp, 'StringOf', @e_invoice OUT, 'data[i].e_invoice'
EXEC sp_OAMethod @jResp, 'StringOf', @ei_code OUT, 'data[i].ei_code'
EXEC sp_OAMethod @jResp, 'StringOf', @discount_highlight OUT, 'data[i].discount_highlight'
EXEC sp_OAMethod @jResp, 'StringOf', @default_discount OUT, 'data[i].default_discount'
EXEC sp_OAMethod @jResp, 'StringOf', @has_intent_declaration OUT, 'data[i].has_intent_declaration'
EXEC sp_OAMethod @jResp, 'StringOf', @intent_declaration_protocol_number OUT, 'data[i].intent_declaration_protocol_number'
EXEC sp_OAMethod @jResp, 'StringOf', @intent_declaration_protocol_date OUT, 'data[i].intent_declaration_protocol_date'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'data[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'data[i].updated_at'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'data[i].default_payment_method.details'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @title OUT, 'data[i].default_payment_method.details[j].title'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'data[i].default_payment_method.details[j].description'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "fields=%3Cstring%3E"
-d "fieldset=basic"
-d "sort=%3Cstring%3E"
-d "page=1"
-d "per_page=5"
-d "q=%3Cstring%3E"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/entities/clients
Postman Collection Item JSON
{
"name": "List Clients",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
"type": "string"
},
{
"key": "redirect_uri",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://api-v2.fattureincloud.it/oauth/authorize",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/entities/clients?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"clients"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "Lists the clients."
},
"response": [
{
"name": "Example response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/entities/clients?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"clients"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"current_page\": \"<integer>\",\n \"first_page_url\": \"<uri>\",\n \"from\": \"<integer>\",\n \"last_page\": \"<integer>\",\n \"last_page_url\": \"<uri>\",\n \"next_page_url\": \"<uri>\",\n \"path\": \"<uri>\",\n \"per_page\": \"<integer>\",\n \"prev_page_url\": \"<uri>\",\n \"to\": \"<integer>\",\n \"total\": \"<integer>\",\n \"data\": [\n {\n \"id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": null,\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"contact_person\": \"<string>\",\n \"vat_number\": \"<string>\",\n \"tax_code\": \"<string>\",\n \"address_street\": \"<string>\",\n \"address_postal_code\": \"<string>\",\n \"address_city\": \"<string>\",\n \"address_province\": \"<string>\",\n \"address_extra\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"certified_email\": \"<string>\",\n \"phone\": \"<string>\",\n \"fax\": \"<string>\",\n \"notes\": \"<string>\",\n \"default_vat\": {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n },\n \"default_payment_terms\": \"<integer>\",\n \"default_payment_terms_type\": \"standard\",\n \"default_payment_method\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"is_default\": \"<boolean>\",\n \"default_payment_account\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n \"details\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n },\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"bank_iban\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bank_beneficiary\": \"<string>\",\n \"ei_payment_method\": \"<string>\"\n },\n \"bank_name\": \"<string>\",\n \"bank_iban\": \"<string>\",\n \"bank_swift_code\": \"<string>\",\n \"shipping_address\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_code\": \"<string>\",\n \"discount_highlight\": \"<boolean>\",\n \"default_discount\": \"<number>\",\n \"has_intent_declaration\": \"<boolean>\",\n \"intent_declaration_protocol_number\": \"<string>\",\n \"intent_declaration_protocol_date\": \"<date>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": null,\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"contact_person\": \"<string>\",\n \"vat_number\": \"<string>\",\n \"tax_code\": \"<string>\",\n \"address_street\": \"<string>\",\n \"address_postal_code\": \"<string>\",\n \"address_city\": \"<string>\",\n \"address_province\": \"<string>\",\n \"address_extra\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"certified_email\": \"<string>\",\n \"phone\": \"<string>\",\n \"fax\": \"<string>\",\n \"notes\": \"<string>\",\n \"default_vat\": {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n },\n \"default_payment_terms\": \"<integer>\",\n \"default_payment_terms_type\": \"standard\",\n \"default_payment_method\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"is_default\": \"<boolean>\",\n \"default_payment_account\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n \"details\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n },\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"bank_iban\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bank_beneficiary\": \"<string>\",\n \"ei_payment_method\": \"<string>\"\n },\n \"bank_name\": \"<string>\",\n \"bank_iban\": \"<string>\",\n \"bank_swift_code\": \"<string>\",\n \"shipping_address\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_code\": \"<string>\",\n \"discount_highlight\": \"<boolean>\",\n \"default_discount\": \"<number>\",\n \"has_intent_declaration\": \"<boolean>\",\n \"intent_declaration_protocol_number\": \"<string>\",\n \"intent_declaration_protocol_date\": \"<date>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/entities/clients?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"clients"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
