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, 'type', 'passive_delivery_note'
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/received_documents', @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>",
-- "type": "expense",
-- "entity": {
-- "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>",
-- "country_iso": "<string>",
-- "email": "<string>",
-- "certified_email": "<string>",
-- "phone": "<string>",
-- "fax": "<string>",
-- "notes": "<string>",
-- "default_payment_terms": "<integer>",
-- "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_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>",
-- "has_intent_declaration": "<boolean>",
-- "intent_declaration_protocol_number": "<string>",
-- "intent_declaration_protocol_date": "<date>",
-- "created_at": "<string>",
-- "updated_at": "<string>"
-- },
-- "date": "<date>",
-- "category": "<string>",
-- "description": "<string>",
-- "amount_net": "<number>",
-- "amount_vat": "<number>",
-- "amount_withholding_tax": "<number>",
-- "amount_other_withholding_tax": "<number>",
-- "amount_gross": "<number>",
-- "amortization": "<number>",
-- "rc_center": "<string>",
-- "invoice_number": "<string>",
-- "is_marked": "<boolean>",
-- "is_detailed": "<boolean>",
-- "e_invoice": "<boolean>",
-- "next_due_date": "<date>",
-- "currency": {
-- "id": "<string>",
-- "symbol": "<string>",
-- "exchange_rate": "<string>",
-- "html_symbol": "<string>"
-- },
-- "tax_deductibility": "<number>",
-- "vat_deductibility": "<number>",
-- "items_list": [
-- {
-- "id": "<integer>",
-- "product_id": "<integer>",
-- "code": "<string>",
-- "name": "<string>",
-- "measure": "<string>",
-- "net_price": "<number>",
-- "category": "<string>",
-- "qty": "<number>",
-- "vat": {
-- "id": "<integer>",
-- "value": "<number>",
-- "description": "<string>",
-- "notes": "<string>",
-- "e_invoice": "<boolean>",
-- "ei_type": "<string>",
-- "ei_description": "<string>",
-- "editable": "<boolean>",
-- "is_disabled": "<boolean>"
-- },
-- "stock": "<number>"
-- },
-- {
-- "id": "<integer>",
-- "product_id": "<integer>",
-- "code": "<string>",
-- "name": "<string>",
-- "measure": "<string>",
-- "net_price": "<number>",
-- "category": "<string>",
-- "qty": "<number>",
-- "vat": {
-- "id": "<integer>",
-- "value": "<number>",
-- "description": "<string>",
-- "notes": "<string>",
-- "e_invoice": "<boolean>",
-- "ei_type": "<string>",
-- "ei_description": "<string>",
-- "editable": "<boolean>",
-- "is_disabled": "<boolean>"
-- },
-- "stock": "<number>"
-- }
-- ],
-- "payments_list": [
-- {
-- "id": "<integer>",
-- "amount": "<number>",
-- "due_date": "<date>",
-- "paid_date": "<date>",
-- "payment_terms": {
-- "days": "<integer>",
-- "type": "standard"
-- },
-- "status": "<string>",
-- "payment_account": {
-- "id": "<integer>",
-- "name": "<string>",
-- "type": "standard",
-- "iban": "<string>",
-- "sia": "<string>",
-- "cuc": "<string>",
-- "virtual": "<boolean>"
-- }
-- },
-- {
-- "id": "<integer>",
-- "amount": "<number>",
-- "due_date": "<date>",
-- "paid_date": "<date>",
-- "payment_terms": {
-- "days": "<integer>",
-- "type": "standard"
-- },
-- "status": "<string>",
-- "payment_account": {
-- "id": "<integer>",
-- "name": "<string>",
-- "type": "standard",
-- "iban": "<string>",
-- "sia": "<string>",
-- "cuc": "<string>",
-- "virtual": "<boolean>"
-- }
-- }
-- ],
-- "attachment_url": "<string>",
-- "attachment_preview_url": "<string>",
-- "auto_calculate": "<boolean>",
-- "attachment_token": "<string>",
-- "created_at": "<string>",
-- "updated_at": "<string>"
-- },
-- {
-- "id": "<integer>",
-- "type": "expense",
-- "entity": {
-- "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>",
-- "country_iso": "<string>",
-- "email": "<string>",
-- "certified_email": "<string>",
-- "phone": "<string>",
-- "fax": "<string>",
-- "notes": "<string>",
-- "default_payment_terms": "<integer>",
-- "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_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>",
-- "has_intent_declaration": "<boolean>",
-- "intent_declaration_protocol_number": "<string>",
-- "intent_declaration_protocol_date": "<date>",
-- "created_at": "<string>",
-- "updated_at": "<string>"
-- },
-- "date": "<date>",
-- "category": "<string>",
-- "description": "<string>",
-- "amount_net": "<number>",
-- "amount_vat": "<number>",
-- "amount_withholding_tax": "<number>",
-- "amount_other_withholding_tax": "<number>",
-- "amount_gross": "<number>",
-- "amortization": "<number>",
-- "rc_center": "<string>",
-- "invoice_number": "<string>",
-- "is_marked": "<boolean>",
-- "is_detailed": "<boolean>",
-- "e_invoice": "<boolean>",
-- "next_due_date": "<date>",
-- "currency": {
-- "id": "<string>",
-- "symbol": "<string>",
-- "exchange_rate": "<string>",
-- "html_symbol": "<string>"
-- },
-- "tax_deductibility": "<number>",
-- "vat_deductibility": "<number>",
-- "items_list": [
-- {
-- "id": "<integer>",
-- "product_id": "<integer>",
-- "code": "<string>",
-- "name": "<string>",
-- "measure": "<string>",
-- "net_price": "<number>",
-- "category": "<string>",
-- "qty": "<number>",
-- "vat": {
-- "id": "<integer>",
-- "value": "<number>",
-- "description": "<string>",
-- "notes": "<string>",
-- "e_invoice": "<boolean>",
-- "ei_type": "<string>",
-- "ei_description": "<string>",
-- "editable": "<boolean>",
-- "is_disabled": "<boolean>"
-- },
-- "stock": "<number>"
-- },
-- {
-- "id": "<integer>",
-- "product_id": "<integer>",
-- "code": "<string>",
-- "name": "<string>",
-- "measure": "<string>",
-- "net_price": "<number>",
-- "category": "<string>",
-- "qty": "<number>",
-- "vat": {
-- "id": "<integer>",
-- "value": "<number>",
-- "description": "<string>",
-- "notes": "<string>",
-- "e_invoice": "<boolean>",
-- "ei_type": "<string>",
-- "ei_description": "<string>",
-- "editable": "<boolean>",
-- "is_disabled": "<boolean>"
-- },
-- "stock": "<number>"
-- }
-- ],
-- "payments_list": [
-- {
-- "id": "<integer>",
-- "amount": "<number>",
-- "due_date": "<date>",
-- "paid_date": "<date>",
-- "payment_terms": {
-- "days": "<integer>",
-- "type": "standard"
-- },
-- "status": "<string>",
-- "payment_account": {
-- "id": "<integer>",
-- "name": "<string>",
-- "type": "standard",
-- "iban": "<string>",
-- "sia": "<string>",
-- "cuc": "<string>",
-- "virtual": "<boolean>"
-- }
-- },
-- {
-- "id": "<integer>",
-- "amount": "<number>",
-- "due_date": "<date>",
-- "paid_date": "<date>",
-- "payment_terms": {
-- "days": "<integer>",
-- "type": "standard"
-- },
-- "status": "<string>",
-- "payment_account": {
-- "id": "<integer>",
-- "name": "<string>",
-- "type": "standard",
-- "iban": "<string>",
-- "sia": "<string>",
-- "cuc": "<string>",
-- "virtual": "<boolean>"
-- }
-- }
-- ],
-- "attachment_url": "<string>",
-- "attachment_preview_url": "<string>",
-- "auto_calculate": "<boolean>",
-- "attachment_token": "<string>",
-- "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 @v_type nvarchar(4000)
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 @Country_iso nvarchar(4000)
DECLARE @v_Email nvarchar(4000)
DECLARE @Certified_email nvarchar(4000)
DECLARE @Phone nvarchar(4000)
DECLARE @Fax nvarchar(4000)
DECLARE @Notes nvarchar(4000)
DECLARE @Default_payment_terms nvarchar(4000)
DECLARE @Default_vatId nvarchar(4000)
DECLARE @Value nvarchar(4000)
DECLARE @Description nvarchar(4000)
DECLARE @Default_vatNotes 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_type nvarchar(4000)
DECLARE @Default_payment_methodId nvarchar(4000)
DECLARE @Default_payment_methodName nvarchar(4000)
DECLARE @Default_payment_methodType 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 @entityBank_name nvarchar(4000)
DECLARE @entityBank_iban nvarchar(4000)
DECLARE @Bank_swift_code nvarchar(4000)
DECLARE @Shipping_address nvarchar(4000)
DECLARE @entityE_invoice nvarchar(4000)
DECLARE @Ei_code 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 @date nvarchar(4000)
DECLARE @category nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @amount_net nvarchar(4000)
DECLARE @amount_vat nvarchar(4000)
DECLARE @amount_withholding_tax nvarchar(4000)
DECLARE @amount_other_withholding_tax nvarchar(4000)
DECLARE @amount_gross nvarchar(4000)
DECLARE @amortization nvarchar(4000)
DECLARE @rc_center nvarchar(4000)
DECLARE @invoice_number nvarchar(4000)
DECLARE @is_marked nvarchar(4000)
DECLARE @is_detailed nvarchar(4000)
DECLARE @e_invoice nvarchar(4000)
DECLARE @next_due_date nvarchar(4000)
DECLARE @currencyId nvarchar(4000)
DECLARE @Symbol nvarchar(4000)
DECLARE @Exchange_rate nvarchar(4000)
DECLARE @Html_symbol nvarchar(4000)
DECLARE @tax_deductibility nvarchar(4000)
DECLARE @vat_deductibility nvarchar(4000)
DECLARE @attachment_url nvarchar(4000)
DECLARE @attachment_preview_url nvarchar(4000)
DECLARE @auto_calculate nvarchar(4000)
DECLARE @attachment_token nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @title nvarchar(4000)
DECLARE @product_id nvarchar(4000)
DECLARE @code nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @measure nvarchar(4000)
DECLARE @net_price nvarchar(4000)
DECLARE @qty nvarchar(4000)
DECLARE @vatId nvarchar(4000)
DECLARE @vatValue nvarchar(4000)
DECLARE @vatDescription nvarchar(4000)
DECLARE @vatNotes nvarchar(4000)
DECLARE @vatE_invoice nvarchar(4000)
DECLARE @vatEi_type nvarchar(4000)
DECLARE @vatEi_description nvarchar(4000)
DECLARE @vatEditable nvarchar(4000)
DECLARE @vatIs_disabled nvarchar(4000)
DECLARE @stock nvarchar(4000)
DECLARE @amount nvarchar(4000)
DECLARE @due_date nvarchar(4000)
DECLARE @paid_date nvarchar(4000)
DECLARE @Days nvarchar(4000)
DECLARE @payment_termsType nvarchar(4000)
DECLARE @status nvarchar(4000)
DECLARE @payment_accountId nvarchar(4000)
DECLARE @payment_accountName nvarchar(4000)
DECLARE @payment_accountType nvarchar(4000)
DECLARE @payment_accountIban nvarchar(4000)
DECLARE @payment_accountSia nvarchar(4000)
DECLARE @payment_accountCuc nvarchar(4000)
DECLARE @payment_accountVirtual 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', @v_type OUT, 'data[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data[i].entity.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Code OUT, 'data[i].entity.code'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'data[i].entity.name'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'data[i].entity.type'
EXEC sp_OAMethod @jResp, 'StringOf', @First_name OUT, 'data[i].entity.first_name'
EXEC sp_OAMethod @jResp, 'StringOf', @Last_name OUT, 'data[i].entity.last_name'
EXEC sp_OAMethod @jResp, 'StringOf', @Contact_person OUT, 'data[i].entity.contact_person'
EXEC sp_OAMethod @jResp, 'StringOf', @Vat_number OUT, 'data[i].entity.vat_number'
EXEC sp_OAMethod @jResp, 'StringOf', @Tax_code OUT, 'data[i].entity.tax_code'
EXEC sp_OAMethod @jResp, 'StringOf', @Address_street OUT, 'data[i].entity.address_street'
EXEC sp_OAMethod @jResp, 'StringOf', @Address_postal_code OUT, 'data[i].entity.address_postal_code'
EXEC sp_OAMethod @jResp, 'StringOf', @Address_city OUT, 'data[i].entity.address_city'
EXEC sp_OAMethod @jResp, 'StringOf', @Address_province OUT, 'data[i].entity.address_province'
EXEC sp_OAMethod @jResp, 'StringOf', @Address_extra OUT, 'data[i].entity.address_extra'
EXEC sp_OAMethod @jResp, 'StringOf', @Country OUT, 'data[i].entity.country'
EXEC sp_OAMethod @jResp, 'StringOf', @Country_iso OUT, 'data[i].entity.country_iso'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Email OUT, 'data[i].entity.email'
EXEC sp_OAMethod @jResp, 'StringOf', @Certified_email OUT, 'data[i].entity.certified_email'
EXEC sp_OAMethod @jResp, 'StringOf', @Phone OUT, 'data[i].entity.phone'
EXEC sp_OAMethod @jResp, 'StringOf', @Fax OUT, 'data[i].entity.fax'
EXEC sp_OAMethod @jResp, 'StringOf', @Notes OUT, 'data[i].entity.notes'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_payment_terms OUT, 'data[i].entity.default_payment_terms'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_vatId OUT, 'data[i].entity.default_vat.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'data[i].entity.default_vat.value'
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'data[i].entity.default_vat.description'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_vatNotes OUT, 'data[i].entity.default_vat.notes'
EXEC sp_OAMethod @jResp, 'StringOf', @E_invoice OUT, 'data[i].entity.default_vat.e_invoice'
EXEC sp_OAMethod @jResp, 'StringOf', @Ei_type OUT, 'data[i].entity.default_vat.ei_type'
EXEC sp_OAMethod @jResp, 'StringOf', @Ei_description OUT, 'data[i].entity.default_vat.ei_description'
EXEC sp_OAMethod @jResp, 'StringOf', @Editable OUT, 'data[i].entity.default_vat.editable'
EXEC sp_OAMethod @jResp, 'StringOf', @Is_disabled OUT, 'data[i].entity.default_vat.is_disabled'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_payment_terms_type OUT, 'data[i].entity.default_payment_terms_type'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_payment_methodId OUT, 'data[i].entity.default_payment_method.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_payment_methodName OUT, 'data[i].entity.default_payment_method.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_payment_methodType OUT, 'data[i].entity.default_payment_method.type'
EXEC sp_OAMethod @jResp, 'StringOf', @Is_default OUT, 'data[i].entity.default_payment_method.is_default'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_payment_accountId OUT, 'data[i].entity.default_payment_method.default_payment_account.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_payment_accountName OUT, 'data[i].entity.default_payment_method.default_payment_account.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Default_payment_accountType OUT, 'data[i].entity.default_payment_method.default_payment_account.type'
EXEC sp_OAMethod @jResp, 'StringOf', @Iban OUT, 'data[i].entity.default_payment_method.default_payment_account.iban'
EXEC sp_OAMethod @jResp, 'StringOf', @Sia OUT, 'data[i].entity.default_payment_method.default_payment_account.sia'
EXEC sp_OAMethod @jResp, 'StringOf', @Cuc OUT, 'data[i].entity.default_payment_method.default_payment_account.cuc'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Virtual OUT, 'data[i].entity.default_payment_method.default_payment_account.virtual'
EXEC sp_OAMethod @jResp, 'StringOf', @Bank_iban OUT, 'data[i].entity.default_payment_method.bank_iban'
EXEC sp_OAMethod @jResp, 'StringOf', @Bank_name OUT, 'data[i].entity.default_payment_method.bank_name'
EXEC sp_OAMethod @jResp, 'StringOf', @Bank_beneficiary OUT, 'data[i].entity.default_payment_method.bank_beneficiary'
EXEC sp_OAMethod @jResp, 'StringOf', @Ei_payment_method OUT, 'data[i].entity.default_payment_method.ei_payment_method'
EXEC sp_OAMethod @jResp, 'StringOf', @entityBank_name OUT, 'data[i].entity.bank_name'
EXEC sp_OAMethod @jResp, 'StringOf', @entityBank_iban OUT, 'data[i].entity.bank_iban'
EXEC sp_OAMethod @jResp, 'StringOf', @Bank_swift_code OUT, 'data[i].entity.bank_swift_code'
EXEC sp_OAMethod @jResp, 'StringOf', @Shipping_address OUT, 'data[i].entity.shipping_address'
EXEC sp_OAMethod @jResp, 'StringOf', @entityE_invoice OUT, 'data[i].entity.e_invoice'
EXEC sp_OAMethod @jResp, 'StringOf', @Ei_code OUT, 'data[i].entity.ei_code'
EXEC sp_OAMethod @jResp, 'StringOf', @Has_intent_declaration OUT, 'data[i].entity.has_intent_declaration'
EXEC sp_OAMethod @jResp, 'StringOf', @Intent_declaration_protocol_number OUT, 'data[i].entity.intent_declaration_protocol_number'
EXEC sp_OAMethod @jResp, 'StringOf', @Intent_declaration_protocol_date OUT, 'data[i].entity.intent_declaration_protocol_date'
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'data[i].entity.created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'data[i].entity.updated_at'
EXEC sp_OAMethod @jResp, 'StringOf', @date OUT, 'data[i].date'
EXEC sp_OAMethod @jResp, 'StringOf', @category OUT, 'data[i].category'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'data[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @amount_net OUT, 'data[i].amount_net'
EXEC sp_OAMethod @jResp, 'StringOf', @amount_vat OUT, 'data[i].amount_vat'
EXEC sp_OAMethod @jResp, 'StringOf', @amount_withholding_tax OUT, 'data[i].amount_withholding_tax'
EXEC sp_OAMethod @jResp, 'StringOf', @amount_other_withholding_tax OUT, 'data[i].amount_other_withholding_tax'
EXEC sp_OAMethod @jResp, 'StringOf', @amount_gross OUT, 'data[i].amount_gross'
EXEC sp_OAMethod @jResp, 'StringOf', @amortization OUT, 'data[i].amortization'
EXEC sp_OAMethod @jResp, 'StringOf', @rc_center OUT, 'data[i].rc_center'
EXEC sp_OAMethod @jResp, 'StringOf', @invoice_number OUT, 'data[i].invoice_number'
EXEC sp_OAMethod @jResp, 'StringOf', @is_marked OUT, 'data[i].is_marked'
EXEC sp_OAMethod @jResp, 'StringOf', @is_detailed OUT, 'data[i].is_detailed'
EXEC sp_OAMethod @jResp, 'StringOf', @e_invoice OUT, 'data[i].e_invoice'
EXEC sp_OAMethod @jResp, 'StringOf', @next_due_date OUT, 'data[i].next_due_date'
EXEC sp_OAMethod @jResp, 'StringOf', @currencyId OUT, 'data[i].currency.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Symbol OUT, 'data[i].currency.symbol'
EXEC sp_OAMethod @jResp, 'StringOf', @Exchange_rate OUT, 'data[i].currency.exchange_rate'
EXEC sp_OAMethod @jResp, 'StringOf', @Html_symbol OUT, 'data[i].currency.html_symbol'
EXEC sp_OAMethod @jResp, 'StringOf', @tax_deductibility OUT, 'data[i].tax_deductibility'
EXEC sp_OAMethod @jResp, 'StringOf', @vat_deductibility OUT, 'data[i].vat_deductibility'
EXEC sp_OAMethod @jResp, 'StringOf', @attachment_url OUT, 'data[i].attachment_url'
EXEC sp_OAMethod @jResp, 'StringOf', @attachment_preview_url OUT, 'data[i].attachment_preview_url'
EXEC sp_OAMethod @jResp, 'StringOf', @auto_calculate OUT, 'data[i].auto_calculate'
EXEC sp_OAMethod @jResp, 'StringOf', @attachment_token OUT, 'data[i].attachment_token'
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].entity.default_payment_method.details'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @title OUT, 'data[i].entity.default_payment_method.details[j].title'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'data[i].entity.default_payment_method.details[j].description'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'data[i].items_list'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data[i].items_list[j].id'
EXEC sp_OAMethod @jResp, 'StringOf', @product_id OUT, 'data[i].items_list[j].product_id'
EXEC sp_OAMethod @jResp, 'StringOf', @code OUT, 'data[i].items_list[j].code'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'data[i].items_list[j].name'
EXEC sp_OAMethod @jResp, 'StringOf', @measure OUT, 'data[i].items_list[j].measure'
EXEC sp_OAMethod @jResp, 'StringOf', @net_price OUT, 'data[i].items_list[j].net_price'
EXEC sp_OAMethod @jResp, 'StringOf', @category OUT, 'data[i].items_list[j].category'
EXEC sp_OAMethod @jResp, 'StringOf', @qty OUT, 'data[i].items_list[j].qty'
EXEC sp_OAMethod @jResp, 'StringOf', @vatId OUT, 'data[i].items_list[j].vat.id'
EXEC sp_OAMethod @jResp, 'StringOf', @vatValue OUT, 'data[i].items_list[j].vat.value'
EXEC sp_OAMethod @jResp, 'StringOf', @vatDescription OUT, 'data[i].items_list[j].vat.description'
EXEC sp_OAMethod @jResp, 'StringOf', @vatNotes OUT, 'data[i].items_list[j].vat.notes'
EXEC sp_OAMethod @jResp, 'StringOf', @vatE_invoice OUT, 'data[i].items_list[j].vat.e_invoice'
EXEC sp_OAMethod @jResp, 'StringOf', @vatEi_type OUT, 'data[i].items_list[j].vat.ei_type'
EXEC sp_OAMethod @jResp, 'StringOf', @vatEi_description OUT, 'data[i].items_list[j].vat.ei_description'
EXEC sp_OAMethod @jResp, 'StringOf', @vatEditable OUT, 'data[i].items_list[j].vat.editable'
EXEC sp_OAMethod @jResp, 'StringOf', @vatIs_disabled OUT, 'data[i].items_list[j].vat.is_disabled'
EXEC sp_OAMethod @jResp, 'StringOf', @stock OUT, 'data[i].items_list[j].stock'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'data[i].payments_list'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data[i].payments_list[j].id'
EXEC sp_OAMethod @jResp, 'StringOf', @amount OUT, 'data[i].payments_list[j].amount'
EXEC sp_OAMethod @jResp, 'StringOf', @due_date OUT, 'data[i].payments_list[j].due_date'
EXEC sp_OAMethod @jResp, 'StringOf', @paid_date OUT, 'data[i].payments_list[j].paid_date'
EXEC sp_OAMethod @jResp, 'StringOf', @Days OUT, 'data[i].payments_list[j].payment_terms.days'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_termsType OUT, 'data[i].payments_list[j].payment_terms.type'
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'data[i].payments_list[j].status'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_accountId OUT, 'data[i].payments_list[j].payment_account.id'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_accountName OUT, 'data[i].payments_list[j].payment_account.name'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_accountType OUT, 'data[i].payments_list[j].payment_account.type'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_accountIban OUT, 'data[i].payments_list[j].payment_account.iban'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_accountSia OUT, 'data[i].payments_list[j].payment_account.sia'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_accountCuc OUT, 'data[i].payments_list[j].payment_account.cuc'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_accountVirtual OUT, 'data[i].payments_list[j].payment_account.virtual'
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 "type=passive_delivery_note"
-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/received_documents
Postman Collection Item JSON
{
"name": "List Received Documents",
"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/received_documents?type=passive_delivery_note&fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents"
],
"query": [
{
"key": "type",
"value": "passive_delivery_note",
"description": "(Required) The type of the received document."
},
{
"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 received documents."
},
"response": [
{
"name": "Results list.",
"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/received_documents?type=passive_delivery_note&fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents"
],
"query": [
{
"key": "type",
"value": "passive_delivery_note",
"description": "(Required) The type of the received document."
},
{
"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 \"type\": \"expense\",\n \"entity\": {\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 \"country_iso\": \"<string>\",\n \"email\": \"<string>\",\n \"certified_email\": \"<string>\",\n \"phone\": \"<string>\",\n \"fax\": \"<string>\",\n \"notes\": \"<string>\",\n \"default_payment_terms\": \"<integer>\",\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_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 \"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 \"date\": \"<date>\",\n \"category\": \"<string>\",\n \"description\": \"<string>\",\n \"amount_net\": \"<number>\",\n \"amount_vat\": \"<number>\",\n \"amount_withholding_tax\": \"<number>\",\n \"amount_other_withholding_tax\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"amortization\": \"<number>\",\n \"rc_center\": \"<string>\",\n \"invoice_number\": \"<string>\",\n \"is_marked\": \"<boolean>\",\n \"is_detailed\": \"<boolean>\",\n \"e_invoice\": \"<boolean>\",\n \"next_due_date\": \"<date>\",\n \"currency\": {\n \"id\": \"<string>\",\n \"symbol\": \"<string>\",\n \"exchange_rate\": \"<string>\",\n \"html_symbol\": \"<string>\"\n },\n \"tax_deductibility\": \"<number>\",\n \"vat_deductibility\": \"<number>\",\n \"items_list\": [\n {\n \"id\": \"<integer>\",\n \"product_id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"measure\": \"<string>\",\n \"net_price\": \"<number>\",\n \"category\": \"<string>\",\n \"qty\": \"<number>\",\n \"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 \"stock\": \"<number>\"\n },\n {\n \"id\": \"<integer>\",\n \"product_id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"measure\": \"<string>\",\n \"net_price\": \"<number>\",\n \"category\": \"<string>\",\n \"qty\": \"<number>\",\n \"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 \"stock\": \"<number>\"\n }\n ],\n \"payments_list\": [\n {\n \"id\": \"<integer>\",\n \"amount\": \"<number>\",\n \"due_date\": \"<date>\",\n \"paid_date\": \"<date>\",\n \"payment_terms\": {\n \"days\": \"<integer>\",\n \"type\": \"standard\"\n },\n \"status\": \"<string>\",\n \"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 },\n {\n \"id\": \"<integer>\",\n \"amount\": \"<number>\",\n \"due_date\": \"<date>\",\n \"paid_date\": \"<date>\",\n \"payment_terms\": {\n \"days\": \"<integer>\",\n \"type\": \"standard\"\n },\n \"status\": \"<string>\",\n \"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 }\n ],\n \"attachment_url\": \"<string>\",\n \"attachment_preview_url\": \"<string>\",\n \"auto_calculate\": \"<boolean>\",\n \"attachment_token\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"type\": \"expense\",\n \"entity\": {\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 \"country_iso\": \"<string>\",\n \"email\": \"<string>\",\n \"certified_email\": \"<string>\",\n \"phone\": \"<string>\",\n \"fax\": \"<string>\",\n \"notes\": \"<string>\",\n \"default_payment_terms\": \"<integer>\",\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_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 \"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 \"date\": \"<date>\",\n \"category\": \"<string>\",\n \"description\": \"<string>\",\n \"amount_net\": \"<number>\",\n \"amount_vat\": \"<number>\",\n \"amount_withholding_tax\": \"<number>\",\n \"amount_other_withholding_tax\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"amortization\": \"<number>\",\n \"rc_center\": \"<string>\",\n \"invoice_number\": \"<string>\",\n \"is_marked\": \"<boolean>\",\n \"is_detailed\": \"<boolean>\",\n \"e_invoice\": \"<boolean>\",\n \"next_due_date\": \"<date>\",\n \"currency\": {\n \"id\": \"<string>\",\n \"symbol\": \"<string>\",\n \"exchange_rate\": \"<string>\",\n \"html_symbol\": \"<string>\"\n },\n \"tax_deductibility\": \"<number>\",\n \"vat_deductibility\": \"<number>\",\n \"items_list\": [\n {\n \"id\": \"<integer>\",\n \"product_id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"measure\": \"<string>\",\n \"net_price\": \"<number>\",\n \"category\": \"<string>\",\n \"qty\": \"<number>\",\n \"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 \"stock\": \"<number>\"\n },\n {\n \"id\": \"<integer>\",\n \"product_id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"measure\": \"<string>\",\n \"net_price\": \"<number>\",\n \"category\": \"<string>\",\n \"qty\": \"<number>\",\n \"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 \"stock\": \"<number>\"\n }\n ],\n \"payments_list\": [\n {\n \"id\": \"<integer>\",\n \"amount\": \"<number>\",\n \"due_date\": \"<date>\",\n \"paid_date\": \"<date>\",\n \"payment_terms\": {\n \"days\": \"<integer>\",\n \"type\": \"standard\"\n },\n \"status\": \"<string>\",\n \"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 },\n {\n \"id\": \"<integer>\",\n \"amount\": \"<number>\",\n \"due_date\": \"<date>\",\n \"paid_date\": \"<date>\",\n \"payment_terms\": {\n \"days\": \"<integer>\",\n \"type\": \"standard\"\n },\n \"status\": \"<string>\",\n \"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 }\n ],\n \"attachment_url\": \"<string>\",\n \"attachment_preview_url\": \"<string>\",\n \"auto_calculate\": \"<boolean>\",\n \"attachment_token\": \"<string>\",\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/received_documents?type=passive_delivery_note&fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents"
],
"query": [
{
"key": "type",
"value": "passive_delivery_note",
"description": "(Required) The type of the received document."
},
{
"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": ""
}
]
}
