{{baseUrl}}/invoices
GET {{baseUrl}}/invoices?createdAt[before]=<string>&createdAt[strictly_before]=<string>&createdAt[after]=<string>&createdAt[strictly_after]=<string>&signed=<boolean>&downloaded=<boolean>&toPa=<string>&type=<string>&sender=<string>&recipient=<string>&invoiceDate[before]=<string>&invoiceDate[strictly_before]=<string>&invoiceDate[after]=<string>&invoiceDate[strictly_after]=<string>&invoiceNumber=<string>&recipient.businessName=<string>&recipient.businessVatNumberCode=<string>&recipient.businessVatNumberCode[]=<string>&recipient.businessVatNumberCode[]=<string>&recipient.businessFiscalCode=<string>&recipient.businessFiscalCode[]=<string>&recipient.businessFiscalCode[]=<string>&sender.businessName=<string>&sender.businessVatNumberCode=<string>&sender.businessVatNumberCode[]=<string>&sender.businessVatNumberCode[]=<string>&sender.businessFiscalCode=<string>&sender.businessFiscalCode[]=<string>&sender.businessFiscalCode[]=<string>&marking=<string>&marking[]=<string>&marking[]=<string>&page=<integer>
This endpoint allows retrieving information about invoices. Various query parameters can be specified to filter the results based on user needs.
Query Parameters: - type (optional): The type of search to be performed. Allowed values: 0 or 1. If 0, invoices where the user is the sender are returned. If 1, invoices where the user is the recipient are returned. If not specified, the default value is 0. - sender (optional): Specifies the sender of the invoices. It can be a single sender or a list of senders separated by commas. - recipient (optional): Specifies the recipient of the invoices. It can be a single recipient or a list of recipients separated by commas.
Example:
Retrieve all invoices for the user:
GET /invoices?type=1
GET /invoices?type=1&recipient=987654321,123456789
GET /invoices?type=0&sender=123456789,987654321
Note:
If type
is not specified, the default value is 0, and all invoices for the user of type 0 are returned.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
createdAt[before] | string | ||
createdAt[strictly_before] | string | ||
createdAt[after] | string | ||
createdAt[strictly_after] | string | ||
signed | string | ||
downloaded | string | ||
toPa | string | Search invoices that was sent to PA. | |
type | string | When type is 0 search for invoices sent to a customer, when type is 1 search for invoice received by a supplier | |
sender | string | Search by sender (vat number OR fiscal code). You can specify more values at once comma separated. | |
recipient | string | Search by recipient (vat number OR fiscal code). You can specify more values at once comma separated. | |
invoiceDate[before] | string | ||
invoiceDate[strictly_before] | string | ||
invoiceDate[after] | string | ||
invoiceDate[strictly_after] | string | ||
invoiceNumber | string | ||
recipient.businessName | string | ||
recipient.businessVatNumberCode | string | ||
recipient.businessVatNumberCode[] | string | ||
recipient.businessVatNumberCode[] | string | ||
recipient.businessFiscalCode | string | ||
recipient.businessFiscalCode[] | string | ||
recipient.businessFiscalCode[] | string | ||
sender.businessName | string | ||
sender.businessVatNumberCode | string | ||
sender.businessVatNumberCode[] | string | ||
sender.businessVatNumberCode[] | string | ||
sender.businessFiscalCode | string | ||
sender.businessFiscalCode[] | string | ||
sender.businessFiscalCode[] | string | ||
marking | string | ||
marking[] | string | ||
marking[] | string | ||
page | string | The collection page number |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"created_at":"1981-01-15T05:33:00.040Z","uuid":"consectetur et eiusmod anim","type":54112181,"payload":"fugiat","sender":{"head_office_address_street":"Excepteu","head_office_address_zip_code":"minim n","head_office_address_city":"fugiat elit","head_office_address_country":"ea dolor in sed","uuid":"aliquip nostrud eiusmod irure","head_office_address_street_number":"Duis do cillum amet sit","head_office_address_province":"cillum et nisi occaecat commodo","office_address_street":"mollit ut ad qui","office_address_street_number":"amet consequat in","office_address_zip_code":"exercitation sint consequat","office_address_city":"Excepteur incididunt quis velit","office_address_province":"adipisicing nulla tempor Excepteur","office_address_country":"f","business_vat_number_country":"cillum est ad ut in","business_vat_number_code":"ipsum irure voluptate","business_fiscal_code":"laborum in officia","business_name":"ea qui magna commodo","name":"pariatur sint Lorem ut ipsum","surname":"esse ut ad","title":"culpa laborum incididunt","cod_eori":"in voluptat","professional_register":"","professional_register_province":"Ut culpa","professional_register_registration_number":"Excepteur ut","professional_register_registration_date":"1998-08-25T13:36:18.272Z","tax_regime":"labore sed quis","contact_phone":"laborum ex aute sit in","contact_fax":"qui nostrud","contact_email":"consectetur","rea_registration_office":"mollit ullamco dolore","rea_registration_number":"in veniam cill","rea_registration_share_capital":"aute in id","rea_registration_sole_shareholder":"","rea_registration_liquidation_status":"commodo","reference_administration":"ullamco consectetur ipsum","fiscal_representative_vat_number_country":"eiusmod","fiscal_representative_vat_number_code":"velit sint ut veniam","fiscal_representative_fiscal_code":"nisi","fiscal_representative_denomination":"occaecat laborum","fiscal_representative_name":"elit","fiscal_representative_surname":"occaecat consectetur","fiscal_representative_title":"elit commodo irure","fiscal_representative_cod_eori":"dolor sed ea"},"recipient":{"head_office_address_street":"Duis","head_office_address_zip_code":"et officia","head_office_address_city":"nostrud ut anim","head_office_address_country":"in mollit","uuid":"velit aliqua","head_office_address_street_number":"laborum in dolore","head_office_address_province":"Lorem aute","office_address_street":"sit pariatur","office_address_street_number":"enim eu id","office_address_zip_code":"sed","office_address_city":"est incididunt aliqua","office_address_province":"minim culpa","office_address_country":"magna est","business_vat_number_country":"laborum sunt par","business_vat_number_code":"Ut et deserunt","business_fiscal_code":"Excepteur","business_name":"occaecat Ut","name":"eiusmod elit culpa","surname":"consectetur nisi deserunt in","title":"incididunt dolore","cod_eori":"sint labore nulla","professional_register":"sint velit","professional_register_province":"dolor","professional_register_registration_number":"pariatur nostrud sit","professional_register_registration_date":"2006-06-25T20:45:03.609Z","tax_regime":"ipsum est deserunt aute pariatur","contact_phone":"consequat ipsum cillum sunt","contact_fax":"pariatur labore eu magna","contact_email":"minim do ea","rea_registration_office":"culpa nisi","rea_registration_number":"magna velit in","rea_registration_share_capital":"in ex","rea_registration_sole_shareholder":"ea magna adipisicing dolore","rea_registration_liquidation_status":"quis irure","reference_administration":"sed cupidatat","fiscal_representative_vat_number_country":"culpa eiusmod consectetur","fiscal_representative_vat_number_code":"ullamco","fiscal_representative_fiscal_code":"in voluptate ipsum laborum","fiscal_representative_denomination":"qui Ut ","fiscal_representative_name":"non","fiscal_representative_surname":"labore do aliquip","fiscal_representative_title":"dolore nostrud minim","fiscal_representative_cod_eori":"amet ut ipsum quis"},"notifications":["","labore in"],"sdi_file_name":"irure sed Duis","sdi_file_id":"aute cillum dolore sunt ullamco","signed":true,"legally_stored":true,"preserved_document":{"created_at":"1978-08-01T09:25:48.058Z","uuid":"amet aliquip Lorem","status":"do aute ut dolore","receipt_received_at":"2004-09-04T01:48:41.495Z","object_type":"enim ullamco dolore Ut","object_id":"velit nulla","message":"incididunt in minim","preserved_object_id":"cillum commodo sint laboris","weight":207784},"downloaded":false,"downloaded_at":"1961-05-20T18:29:56.452Z","marking":"exercitation qu","notice":"commodo","retry_information":"irure ullamco","transmission_format":"elit sint","to_pa":true},{"created_at":"2016-08-05T20:14:24.227Z","uuid":"Ut","type":-67830133,"payload":"Lorem dolor","sender":{"head_office_address_street":"Ut aliquip","head_office_address_zip_code":"nisi consecte","head_office_address_city":"dolor aute anim et","head_office_address_country":"Duis qui","uuid":"mollit commodo Ut ut Duis","head_office_address_street_number":"magna ipsum dolor culpa","head_office_address_province":"minim sed cillum incididunt ut","office_address_street":"aliqua laborum","office_address_street_number":"nostrud ","office_address_zip_code":"elit ullamco mollit labore minim","office_address_city":"id Duis amet ut cupidatat","office_address_province":"non dolore","office_address_country":"","business_vat_number_country":"dolor eiusmod consectetur in","business_vat_number_code":"elit fugiat in","business_fiscal_code":"dolor velit dolore dolore","business_name":"aliquip ad voluptate est dolor","name":"cillum ipsum consequat non","surname":"veniam","title":"adipisicing nostrud pariatur ut","cod_eori":"nulla Duis","professional_register":"amet sunt","professional_register_province":"est","professional_register_registration_number":"est magna cillum","professional_register_registration_date":"1974-04-21T21:37:47.436Z","tax_regime":"culpa","contact_phone":"do ad velit tempo","contact_fax":"officia id","contact_email":"consecte","rea_registration_office":"Lorem Ut laboris ipsum","rea_registration_number":"enim","rea_registration_share_capital":"ad exercitation mollit in","rea_registration_sole_shareholder":"et est a","rea_registration_liquidation_status":"Lorem dolor","reference_administration":"sed tempor ullamco laboris","fiscal_representative_vat_number_country":"do commodo","fiscal_representative_vat_number_code":"consequat sunt ut","fiscal_representative_fiscal_code":"magna laboris ","fiscal_representative_denomination":"in ut mollit Duis","fiscal_representative_name":"ipsum qui","fiscal_representative_surname":"do non","fiscal_representative_title":"eiusmod officia Duis eu","fiscal_representative_cod_eori":"nulla amet"},"recipient":{"head_office_address_street":"nisi veniam aute esse irure","head_office_address_zip_code":"dolor aliquip voluptate dolore","head_office_address_city":"nulla Duis Ut","head_office_address_country":"laborum cillum dolore consectetur nostrud","uuid":"qui proident dolor reprehenderit","head_office_address_street_number":"Ut","head_office_address_province":"dolor est consequat","office_address_street":"cupidatat occaecat fu","office_address_street_number":"fugiat commodo eiusmod deserunt","office_address_zip_code":"ea eiusmod nulla sunt","office_address_city":"sed velit non aute","office_address_province":"amet nostrud irure","office_address_country":"ea est minim","business_vat_number_country":"labore","business_vat_number_code":"laboris ut do","business_fiscal_code":"eu pariatur","business_name":"laborum quis do","name":"eu incididunt reprehenderit ","surname":"eiusmod","title":"dolore incididunt proident mollit","cod_eori":"exercitation adipisicing","professional_register":"sint dolor adipisicing minim occaecat","professional_register_province":"eiusmod tempor dolore labore","professional_register_registration_number":"ut nulla in aliqua laboris","professional_register_registration_date":"2012-01-13T00:25:12.259Z","tax_regime":"Ut sit ea aliquip","contact_phone":"Ut veniam in","contact_fax":"tempor","contact_email":"labore magna","rea_registration_office":"aliquip aute do sed","rea_registration_number":"aliqua reprehenderit","rea_registration_share_capital":"Duis c","rea_registration_sole_shareholder":"ad reprehenderit commodo culpa","rea_registration_liquidation_status":"in ipsum","reference_administration":"id irure eu","fiscal_representative_vat_number_country":"aute ex ","fiscal_representative_vat_number_code":"exercitation id fugiat dolor","fiscal_representative_fiscal_code":"laborum laboris minim enim do","fiscal_representative_denomination":"sint anim","fiscal_representative_name":"officia reprehenderit pariatur esse","fiscal_representative_surname":"ipsum ut aliqua esse","fiscal_representative_title":"proident ex anim","fiscal_representative_cod_eori":"in in veniam Ut"},"notifications":["anim ut","fugiat non"],"sdi_file_name":"veniam","sdi_file_id":"velit","signed":false,"legally_stored":false,"preserved_document":{"created_at":"1949-01-12T08:36:47.208Z","uuid":"deserunt in sed mollit","status":"ad Lorem","receipt_received_at":"2011-01-16T17:07:30.421Z","object_type":"commodo in","object_id":"nulla minim ","message":"commodo anim sunt Exce","preserved_object_id":"commodo qui ex","weight":-80389859},"downloaded":true,"downloaded_at":"2020-12-22T12:49:01.830Z","marking":"adipisicing ut ullamco","notice":"amet sit","retry_information":"officia","transmission_format":"mollit dolore ex id","to_pa":false}],"success":false,"message":"irure pariatur Lorem","error":{}}