Sibill Integration API Beta Version (1.0.0)

API reference (Beta)

The Sibill API is organized around REST. Our API has predictable resource-oriented URLs, accepts multiple encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication

The Sibill API uses API keys to authenticate requests. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. All API requests must be made over HTTPS. API requests without authentication will fail.

Errors

Sibill uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Sibill’s servers. Some 4xx errors that could be handled programmatically (e.g., an invoice is declined) include an error code that briefly explains the error reported.

HTTP Status Code	Meaning	Description
200	OK	Everything worked as expected.
400	Bad Request	The request was unacceptable, often due to missing a required parameter.
401	Unauthorized	No valid API key provided.
402	Request Failed	The parameters were valid but the request failed.
403	Forbidden	The API key doesn’t have permissions to perform the request.
404	Not Found	The requested resource doesn’t exist.
500, 502, 503, 504	Server Errors	Something went wrong on Sibill’s end.

Environments

There are two available environments: Development and Production. The base_url will change depending on the selected environment:

Development: https://integration.dev.sibill.com
Production: https://integration.sibill.com

Webhook

Document updated event Webhook

Triggered when a Document has successfully been updated.

Request Body schema: application/json
required

company_id required	string <uuid> Company identifier
required	object (DocumentSchema) Document data representation
id required	string <uuid> The id of the event
event required	string Value: "document.updated" The type of the event that happend to the resource

Responses

Request samples

Payload

Content type

application/json

{"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"data": {"category": {"id": "019dfbe1-d0d7-78e8-b987-5058e3ed5fed",
"name": "string"
},
"counterpart": {"address": "string",
"city": "string",
"company_name": "string",
"country": "string",
"destination_code": "string",
"id": "019dfbe1-cfdf-79e9-9127-e143b5d9b08e",
"postal_code": "string",
"province_code": "string",
"tax_number": "string",
"vat_number": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"creation_date": "2019-08-24",
"delivery_date": "string",
"delivery_status": "string",
"direction": "ISSUED",
"file_name": "string",
"flows": [{"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
}
],
"format": "FPA12",
"gross_amount": {"amount": "12.3",
"currency": "EUR"
},
"id": "019dfbe1-d0d7-7564-9e1d-a9c29cd9f878",
"is_e_invoice": true,
"notes": "string",
"number": "string",
"status": "DRAFT",
"subcategory": {"id": "019dfbe1-d0d7-744f-9e57-83f25ff5827f",
"name": "string"
},
"type": "BILL",
"updated_at": "2019-08-24T14:15:22Z",
"vat_amount": {"amount": "12.3",
"currency": "EUR"
}
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"event": "document.updated"
}

Flow updated event Webhook

Triggered when a Flow has successfully been updated.

Request Body schema: application/json
required

company_id required	string <uuid> Company identifier
required	object (FlowSchema) Flow data representation
id required	string <uuid> The id of the event
event required	string Value: "flow.updated" The type of the event that happened to the resource

Responses

Request samples

Payload

Content type

application/json

{"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"data": {"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"event": "flow.updated"
}

Company

List all the available companies

List all the companies for the current integrator

Authorizations:

None

query Parameters

expand

string

Fields that will be expanded. Expandable fields: subscriptions

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
401

Content type

application/json

{"data": [{"country": "string",
"fiscal_regime": "string",
"id": "019dfbe1-cfd8-7d8e-ab6c-d2c4ef72c60e",
"name": "string",
"subscriptions": [{"created_at": "2019-08-24T14:15:22Z",
"status": "PRE_TRIAL"
}
],
"vat_number": "string"
}
]
}

Account

List all accounts for the company

The return value is paginated. By default the response contains 25 elements per page but can be instructed to return more elements per page. A cursor is needed to traverse the results.

Authorizations:

None

path Parameters

company_id

required

string

The company the accounts belong to

query Parameters

page_size	integer The page size
cursor	string The pagination cursor. A cursor is used to paginate through a large set of data. It is a unique identifier that represents a specific position in the dataset.
filter	object List of filters on the resource. Currently the fields that allow to be filtered are: `id`
sort	string Fields for which we can order the results. Sortable fields: `created_at`

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/accounts \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
400
401
403
500

Content type

application/json

{"data": [{"available_balance": {"amount": "12.3",
"currency": "EUR"
},
"balance_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"credit_limit": {"amount": "12.3",
"currency": "EUR"
},
"currency": "AED",
"current_balance": {"amount": "12.3",
"currency": "EUR"
},
"id": "019dfbe1-cfd6-7b74-8102-cdf3748d0841",
"nickname": "string"
}
],
"page": {"cursor": "string",
"size": 0
}
}

Get a account

Returns all the information for a specific account from its identifier

Authorizations:

None

path Parameters

company_id required	string The company the account belongs to
id required	string The account identifier

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/accounts/:account_id \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
401
403
404

Content type

application/json

{"data": {"available_balance": {"amount": "12.3",
"currency": "EUR"
},
"balance_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"credit_limit": {"amount": "12.3",
"currency": "EUR"
},
"currency": "AED",
"current_balance": {"amount": "12.3",
"currency": "EUR"
},
"id": "019dfbe1-cfd6-7b74-8102-cdf3748d0841",
"nickname": "string"
}
}

List all categories for the company

The return value is paginated. By default the response contains 25 elements per page but can be instructed to return more elements per page. A cursor is needed to traverse the results.

Authorizations:

None

path Parameters

company_id

required

string

The company the categories belong to

query Parameters

page_size	integer The page size
cursor	string The pagination cursor. A cursor is used to paginate through a large set of data. It is a unique identifier that represents a specific position in the dataset.
filter	object List of filters on the resource. Currently the fields that allow to be filtered are: `id`, `name`
sort	string Fields for which we can order the results. Sortable fields: `name`

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/categories \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
400
401
403
500

Content type

application/json

{"data": [{"id": "019dfbe1-cfd7-7e32-9ab7-822b5c5be149",
"name": "string"
}
],
"page": {"cursor": "string",
"size": 0
}
}

Get a category

Returns all the information for a specific category from its identifier

Authorizations:

None

path Parameters

company_id required	string The company the category belongs to
id required	string The category identifier

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/categories/:category_id \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
401
403
404

Content type

application/json

{"data": {"id": "019dfbe1-cfd7-7e32-9ab7-822b5c5be149",
"name": "string"
}
}

Counterpart

Get the list of counterparts

The return value is paginated. By default the response contains 25 elements per page but can be instructed to return more elements per page. A cursor is needed to traverse the results.

Authorizations:

None

path Parameters

company_id

required

string

The company the counterparts belongs to

query Parameters

page_size	integer The page size
cursor	string The pagination cursor. A cursor is used to paginate through a large set of data. It is a unique identifier that represents a specific position in the dataset.
filter	object List of filters on the resource. Currently the fields that allow to be filtered are: `vat_number`, `tax_number`, `company_name`
sort	string Fields for which we can order the results. Sortable fields: `company_name`

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/counterparts \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
401
403
404

Content type

application/json

{"data": [{"address": "string",
"city": "string",
"company_name": "string",
"country": "string",
"destination_code": "string",
"id": "019dfbe1-cfdf-79e9-9127-e143b5d9b08e",
"postal_code": "string",
"province_code": "string",
"tax_number": "string",
"vat_number": "string"
}
],
"page": {"cursor": "string",
"size": 0
}
}

Get a specific counterpart

Authorizations:

None

path Parameters

company_id required	string The company the counterpart belongs to
id required	string The counterpart identifier

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/counterparts/:counterpart_id \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
401
403
404

Content type

application/json

{"data": {"address": "string",
"city": "string",
"company_name": "string",
"country": "string",
"destination_code": "string",
"id": "019dfbe1-cfdf-79e9-9127-e143b5d9b08e",
"postal_code": "string",
"province_code": "string",
"tax_number": "string",
"vat_number": "string"
}
}

Search counterpart informations

Search for counterpart information from a third-party system.

Authorizations:

None

query Parameters

vat_number

required

string

The VAT number of the counterpart to search

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/counterparts/search \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
401
403
404

Content type

application/json

{"data": {"address": "string",
"city": "string",
"company_name": "string",
"country": "string",
"postal_code": "string",
"province_code": "string",
"tax_number": "string",
"vat_number": "string"
}
}

Document

List all the company's documents

The return value is paginated. By default the response contains 25 elements per page but can be instructed to return more elements per page. A cursor is needed to traverse the results.

Authorizations:

None

path Parameters

company_id

required

string

The company the documents belong to

query Parameters

page_size	integer The page size
cursor	string The pagination cursor. A cursor is used to paginate through a large set of data. It is a unique identifier that represents a specific position in the dataset.
expand	string Fields that will be expanded. Expandable fields: `category`, `counterpart`, `flows`, `subcategory`
filter	object List of filters on the resource. Currently the fields that allow to be filtered are: `creation_date`, `delivery_date`, `direction`, `status`, `type`, `number`,`counterpart_company_name`, `notes`, `source_id`
sort	string Fields for which we can order the results. Sortable fields: `created_at`, `creation_date`, `delivery_date`, `number`

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/documents \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
400
401
403
500

Content type

application/json

{"data": [{"category": {"id": "019dfbe1-d0d7-78e8-b987-5058e3ed5fed",
"name": "string"
},
"counterpart": {"address": "string",
"city": "string",
"company_name": "string",
"country": "string",
"destination_code": "string",
"id": "019dfbe1-cfdf-79e9-9127-e143b5d9b08e",
"postal_code": "string",
"province_code": "string",
"tax_number": "string",
"vat_number": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"creation_date": "2019-08-24",
"delivery_date": "string",
"delivery_status": "string",
"direction": "ISSUED",
"file_name": "string",
"flows": [{"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
}
],
"format": "FPA12",
"gross_amount": {"amount": "12.3",
"currency": "EUR"
},
"id": "019dfbe1-d0d7-7564-9e1d-a9c29cd9f878",
"is_e_invoice": true,
"notes": "string",
"number": "string",
"status": "DRAFT",
"subcategory": {"id": "019dfbe1-d0d7-744f-9e57-83f25ff5827f",
"name": "string"
},
"type": "BILL",
"updated_at": "2019-08-24T14:15:22Z",
"vat_amount": {"amount": "12.3",
"currency": "EUR"
}
}
],
"page": {"cursor": "string",
"size": 0
}
}

Create an invoice and issue it

Create an invoice. By default will be created as draft and not issued.

The request body (that could be application/xml or application/json) represent the Italian Electronic invoice format. For example, if the XML content comes from another system — perhaps as a file — the request body will contain the file's content. The content should represent only one invoice; content with multiple invoices is not supported yet.

The invoice numero is under customer control (i.e. customer must choose it), while the file name and the progressivo invio are automatically generated by the system.

Authorizations:

None

path Parameters

company_id

required

string

The company where to execute the operation

query Parameters

issue	boolean Issue the invoice after creating it. If true, the invoice is issued. Default value is false. In this case, the invoice is created as a draft and not issued.
reconciliation_identifier	string A unique identifier used to match an invoice with its corresponding transaction. This can be, for example, an ID coming from your collection system (ex. Transaction ID on Stripe or Paypal) that you want to pass when issuing the invoice to be able to reconcile the movement and the invoice automatically

header Parameters

content-type

required

string

Indicate the original mime type of the resource. It could be application/xml or application/json

Request Body schema:
application/json
required

The user attributes

	Array of objects (Body)
	object
namespace	string
sistema_emittente	string
versione	string Enum: "FPA12" "FPR12"

Responses

Request samples

Content type

application/json

{"fattura_elettronica_body": [{"allegati": [{"algoritmo_compressione": "string",
"attachment": "string",
"descrizione_attachment": "string",
"formato_attachment": "string",
"nome_attachment": "string"
}
],
"dati_beni_servizi": {"dati_riepilogo": [{"aliquota_iva": "string",
"arrotondamento": "string",
"esigibilita_iva": "string",
"imponibile_importo": "string",
"imposta": "string",
"natura": "N1",
"riferimento_normativo": "string",
"spese_accessorie": "string"
}
],
"dettaglio_linee": [{"aliquota_iva": "string",
"altri_dati_gestionali": [{"riferimento_data": "string",
"riferimento_numero": "string",
"riferimento_testo": "string",
"tipo_dato": "string"
}
],
"codice_articolo": [{"codice_tipo": "string",
"codice_valore": "string"
}
],
"data_fine_periodo": "string",
"data_inizio_periodo": "string",
"descrizione": "string",
"natura": "N1",
"numero_linea": "string",
"prezzo_totale": "string",
"prezzo_unitario": "string",
"quantita": "string",
"riferimento_amministrazione": "string",
"ritenuta": "string",
"sconto_maggiorazione": [{"importo": "string",
"percentuale": "string",
"tipo": "string"
}
],
"tipo_cessione_prestazione": "SC",
"unita_misura": "string"
}
]
},
"dati_generali": {"dati_contratto": [{"codice_cig": "string",
"codice_commessa_convenzione": "string",
"codice_cup": "string",
"data": "string",
"id_documento": "string",
"num_item": "string",
"riferimento_numero_linea": [0
]
}
],
"dati_convenzione": [{"codice_cig": "string",
"codice_commessa_convenzione": "string",
"codice_cup": "string",
"data": "string",
"id_documento": "string",
"num_item": "string",
"riferimento_numero_linea": [0
]
}
],
"dati_ddt": [{"data_ddt": "string",
"numero_ddt": "string",
"riferimento_numero_linea": ["string"
]
}
],
"dati_fatture_collegate": [{"codice_cig": "string",
"codice_commessa_convenzione": "string",
"codice_cup": "string",
"data": "string",
"id_documento": "string",
"num_item": "string",
"riferimento_numero_linea": [0
]
}
],
"dati_generali_documento": {"arrotondamento": "string",
"art_73": "SI",
"causale": ["string"
],
"data": "string",
"dati_bollo": {"bollo_virtuale": "string",
"importo_bollo": "string"
},
"dati_cassa_previdenziale": [{"al_cassa": "string",
"aliquota_iva": "string",
"imponibile_cassa": "string",
"importo_contributo_cassa": "string",
"natura": "N1",
"riferimento_amministrazione": "string",
"ritenuta": "string",
"tipo_cassa": "TC01"
}
],
"dati_ritenuta": [{"aliquota_ritenuta": "string",
"causale_pagamento": "A",
"importo_ritenuta": "string",
"tipo_ritenuta": "RT01"
}
],
"divisa": "string",
"importo_totale_documento": "string",
"numero": "string",
"sconto_maggiorazione": [{"importo": "string",
"percentuale": "string",
"tipo": "MG"
}
],
"tipo_documento": "TD01"
},
"dati_ordine_acquisto": [{"codice_cig": "string",
"codice_commessa_convenzione": "string",
"codice_cup": "string",
"data": "string",
"id_documento": "string",
"num_item": "string",
"riferimento_numero_linea": [0
]
}
],
"dati_ricezione": [{"codice_cig": "string",
"codice_commessa_convenzione": "string",
"codice_cup": "string",
"data": "string",
"id_documento": "string",
"num_item": "string",
"riferimento_numero_linea": [0
]
}
],
"dati_sal": [{"riferimento_fase": "string"
}
],
"dati_trasporto": {"causale_trasporto": "string",
"data_inizio_trasporto": "string",
"data_ora_consegna": "string",
"data_ora_ritiro": "string",
"dati_anagrafici_vettore": {"anagrafica": {"cod_eori": "string",
"cognome": "string",
"denominazione": "string",
"nome": "string",
"titolo": "string"
},
"codice_fiscale": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
},
"numero_licenza_guida": "string"
},
"descrizione": "string",
"indirizzo_resa": {"cap": "string",
"comune": "string",
"indirizzo": "string",
"nazione": "string",
"numero_civico": "string",
"provincia": "string"
},
"mezzo_trasporto": "string",
"numero_colli": 0,
"peso_lordo": "string",
"peso_netto": "string",
"tipo_resa": "string",
"unita_misura_peso": "string"
},
"fattura_principale": {"data_fattura_principale": "string",
"numero_fattura_principale": "string"
}
},
"dati_pagamento": [{"condizioni_pagamento": "TP01",
"dettaglio_pagamento": [{"abi": "string",
"beneficiario": "string",
"bic": "string",
"cab": "string",
"cf_quietanzante": "string",
"cod_ufficio_postale": "string",
"codice_pagamento": "string",
"cognome_quietanzante": "string",
"data_decorrenza_penale": "string",
"data_limite_pagamento_anticipato": "string",
"data_riferimento_termini_pagamento": "string",
"data_scadenza_pagamento": "string",
"giorni_termini_pagamento": 0,
"iban": "string",
"importo_pagamento": "string",
"istituto_finanziario": "string",
"modalita_pagamento": "MP01",
"nome_quietanzante": "string",
"penalita_pagamenti_ritardati": "string",
"sconto_pagamento_anticipato": "string",
"titolo_quietanzante": "string"
}
]
}
],
"dati_veicoli": {"data": "string",
"totale_percorso": "string"
}
}
],
"fattura_elettronica_header": {"cedente_prestatore": {"contatti": {"email": "string",
"fax": "string",
"telefono": "string"
},
"dati_anagrafici": {"albo_professionale": "string",
"anagrafica": {"cod_eori": "string",
"cognome": "string",
"denominazione": "string",
"nome": "string",
"titolo": "string"
},
"codice_fiscale": "string",
"data_iscrizione_albo": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
},
"numero_iscrizione_albo": "string",
"provincia_albo": "string",
"regime_fiscale": "RF01"
},
"iscrizione_rea": {"capitale_sociale": "string",
"numero_rea": "string",
"socio_unico": "SU",
"stato_liquidazione": "LS",
"ufficio": "string"
},
"riferimento_amministrazione": "string",
"sede": {"cap": "string",
"comune": "string",
"indirizzo": "string",
"nazione": "string",
"numero_civico": "string",
"provincia": "string"
},
"stabile_organizzazione": {"cap": "string",
"comune": "string",
"indirizzo": "string",
"nazione": "string",
"numero_civico": "string",
"provincia": "string"
}
},
"cessionario_committente": {"dati_anagrafici": {"anagrafica": {"cod_eori": "string",
"cognome": "string",
"denominazione": "string",
"nome": "string",
"titolo": "string"
},
"codice_fiscale": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
}
},
"rappresentante_fiscale": {"cognome": "string",
"denominazione": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
},
"nome": "string"
},
"sede": {"cap": "string",
"comune": "string",
"indirizzo": "string",
"nazione": "string",
"numero_civico": "string",
"provincia": "string"
},
"stabile_organizzazione": {"cap": "string",
"comune": "string",
"indirizzo": "string",
"nazione": "string",
"numero_civico": "string",
"provincia": "string"
}
},
"dati_trasmissione": {"codice_destinatario": "string",
"contatti_trasmittente": {"email": "string",
"telefono": "string"
},
"formato_trasmissione": "FPA12",
"id_trasmittente": {"id_codice": "string",
"id_paese": "string"
},
"pec_destinatario": "string",
"progressivo_invio": "string"
},
"rappresentante_fiscale": {"dati_anagrafici": {"anagrafica": {"cod_eori": "string",
"cognome": "string",
"denominazione": "string",
"nome": "string",
"titolo": "string"
},
"codice_fiscale": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
}
}
},
"soggetto_emittente": "CC",
"terzo_intermediario_o_soggetto_emittente": {"dati_anagrafici": {"anagrafica": {"cod_eori": "string",
"cognome": "string",
"denominazione": "string",
"nome": "string",
"titolo": "string"
},
"codice_fiscale": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
}
}
}
},
"namespace": "string",
"sistema_emittente": "string",
"versione": "FPA12"
}

Response samples

Content type

application/json

{"data": [{"category": {"id": "019dfbe1-d0d7-78e8-b987-5058e3ed5fed",
"name": "string"
},
"counterpart": {"address": "string",
"city": "string",
"company_name": "string",
"country": "string",
"destination_code": "string",
"id": "019dfbe1-cfdf-79e9-9127-e143b5d9b08e",
"postal_code": "string",
"province_code": "string",
"tax_number": "string",
"vat_number": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"creation_date": "2019-08-24",
"delivery_date": "string",
"delivery_status": "string",
"direction": "ISSUED",
"file_name": "string",
"flows": [{"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
}
],
"format": "FPA12",
"gross_amount": {"amount": "12.3",
"currency": "EUR"
},
"id": "019dfbe1-d0d7-7564-9e1d-a9c29cd9f878",
"is_e_invoice": true,
"notes": "string",
"number": "string",
"status": "DRAFT",
"subcategory": {"id": "019dfbe1-d0d7-744f-9e57-83f25ff5827f",
"name": "string"
},
"type": "BILL",
"updated_at": "2019-08-24T14:15:22Z",
"vat_amount": {"amount": "12.3",
"currency": "EUR"
}
}
]
}

Get a document invoice by its identifier

Retrieve a specific document invoice along with a signed url to the xml representation of the invoice. The signed url provides a secure and temporary access to the xml data.

Authorizations:

None

path Parameters

company_id required	string The company the document invoice belongs to
document_id required	string The document identifier

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/documents/:document_id/invoice \
     --header "Authorization: Bearer ${authorization_token}" \
     --header "Content-Type: application/json"

Response samples

200
400
401
403
404

Content type

application/json

{"data": {"invoice": {"fattura_elettronica_body": [{"allegati": [{"algoritmo_compressione": "string",
"attachment": "string",
"descrizione_attachment": "string",
"formato_attachment": "string",
"nome_attachment": "string"
}
],
"dati_beni_servizi": {"dati_riepilogo": [{"aliquota_iva": "string",
"arrotondamento": "string",
"esigibilita_iva": "string",
"imponibile_importo": "string",
"imposta": "string",
"natura": "N1",
"riferimento_normativo": "string",
"spese_accessorie": "string"
}
],
"dettaglio_linee": [{"aliquota_iva": "string",
"altri_dati_gestionali": [{"riferimento_data": null,
"riferimento_numero": null,
"riferimento_testo": null,
"tipo_dato": null
}
],
"codice_articolo": [{"codice_tipo": null,
"codice_valore": null
}
],
"data_fine_periodo": "string",
"data_inizio_periodo": "string",
"descrizione": "string",
"natura": "N1",
"numero_linea": "string",
"prezzo_totale": "string",
"prezzo_unitario": "string",
"quantita": "string",
"riferimento_amministrazione": "string",
"ritenuta": "string",
"sconto_maggiorazione": [{"importo": null,
"percentuale": null,
"tipo": null
}
],
"tipo_cessione_prestazione": "SC",
"unita_misura": "string"
}
]
},
"dati_generali": {"dati_contratto": [{"codice_cig": "string",
"codice_commessa_convenzione": "string",
"codice_cup": "string",
"data": "string",
"id_documento": "string",
"num_item": "string",
"riferimento_numero_linea": [0
]
}
],
"dati_convenzione": [{"codice_cig": "string",
"codice_commessa_convenzione": "string",
"codice_cup": "string",
"data": "string",
"id_documento": "string",
"num_item": "string",
"riferimento_numero_linea": [0
]
}
],
"dati_ddt": [{"data_ddt": "string",
"numero_ddt": "string",
"riferimento_numero_linea": ["string"
]
}
],
"dati_fatture_collegate": [{"codice_cig": "string",
"codice_commessa_convenzione": "string",
"codice_cup": "string",
"data": "string",
"id_documento": "string",
"num_item": "string",
"riferimento_numero_linea": [0
]
}
],
"dati_generali_documento": {"arrotondamento": "string",
"art_73": "SI",
"causale": ["string"
],
"data": "string",
"dati_bollo": {"bollo_virtuale": "string",
"importo_bollo": "string"
},
"dati_cassa_previdenziale": [{"al_cassa": "string",
"aliquota_iva": "string",
"imponibile_cassa": "string",
"importo_contributo_cassa": "string",
"natura": "N1",
"riferimento_amministrazione": "string",
"ritenuta": "string",
"tipo_cassa": "TC01"
}
],
"dati_ritenuta": [{"aliquota_ritenuta": "string",
"causale_pagamento": "A",
"importo_ritenuta": "string",
"tipo_ritenuta": "RT01"
}
],
"divisa": "string",
"importo_totale_documento": "string",
"numero": "string",
"sconto_maggiorazione": [{"importo": "string",
"percentuale": "string",
"tipo": "MG"
}
],
"tipo_documento": "TD01"
},
"dati_ordine_acquisto": [{"codice_cig": "string",
"codice_commessa_convenzione": "string",
"codice_cup": "string",
"data": "string",
"id_documento": "string",
"num_item": "string",
"riferimento_numero_linea": [0
]
}
],
"dati_ricezione": [{"codice_cig": "string",
"codice_commessa_convenzione": "string",
"codice_cup": "string",
"data": "string",
"id_documento": "string",
"num_item": "string",
"riferimento_numero_linea": [0
]
}
],
"dati_sal": [{"riferimento_fase": "string"
}
],
"dati_trasporto": {"causale_trasporto": "string",
"data_inizio_trasporto": "string",
"data_ora_consegna": "string",
"data_ora_ritiro": "string",
"dati_anagrafici_vettore": {"anagrafica": {"cod_eori": "string",
"cognome": "string",
"denominazione": "string",
"nome": "string",
"titolo": "string"
},
"codice_fiscale": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
},
"numero_licenza_guida": "string"
},
"descrizione": "string",
"indirizzo_resa": {"cap": "string",
"comune": "string",
"indirizzo": "string",
"nazione": "string",
"numero_civico": "string",
"provincia": "string"
},
"mezzo_trasporto": "string",
"numero_colli": 0,
"peso_lordo": "string",
"peso_netto": "string",
"tipo_resa": "string",
"unita_misura_peso": "string"
},
"fattura_principale": {"data_fattura_principale": "string",
"numero_fattura_principale": "string"
}
},
"dati_pagamento": [{"condizioni_pagamento": "TP01",
"dettaglio_pagamento": [{"abi": "string",
"beneficiario": "string",
"bic": "string",
"cab": "string",
"cf_quietanzante": "string",
"cod_ufficio_postale": "string",
"codice_pagamento": "string",
"cognome_quietanzante": "string",
"data_decorrenza_penale": "string",
"data_limite_pagamento_anticipato": "string",
"data_riferimento_termini_pagamento": "string",
"data_scadenza_pagamento": "string",
"giorni_termini_pagamento": 0,
"iban": "string",
"importo_pagamento": "string",
"istituto_finanziario": "string",
"modalita_pagamento": "MP01",
"nome_quietanzante": "string",
"penalita_pagamenti_ritardati": "string",
"sconto_pagamento_anticipato": "string",
"titolo_quietanzante": "string"
}
]
}
],
"dati_veicoli": {"data": "string",
"totale_percorso": "string"
}
}
],
"fattura_elettronica_header": {"cedente_prestatore": {"contatti": {"email": "string",
"fax": "string",
"telefono": "string"
},
"dati_anagrafici": {"albo_professionale": "string",
"anagrafica": {"cod_eori": "string",
"cognome": "string",
"denominazione": "string",
"nome": "string",
"titolo": "string"
},
"codice_fiscale": "string",
"data_iscrizione_albo": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
},
"numero_iscrizione_albo": "string",
"provincia_albo": "string",
"regime_fiscale": "RF01"
},
"iscrizione_rea": {"capitale_sociale": "string",
"numero_rea": "string",
"socio_unico": "SU",
"stato_liquidazione": "LS",
"ufficio": "string"
},
"riferimento_amministrazione": "string",
"sede": {"cap": "string",
"comune": "string",
"indirizzo": "string",
"nazione": "string",
"numero_civico": "string",
"provincia": "string"
},
"stabile_organizzazione": {"cap": "string",
"comune": "string",
"indirizzo": "string",
"nazione": "string",
"numero_civico": "string",
"provincia": "string"
}
},
"cessionario_committente": {"dati_anagrafici": {"anagrafica": {"cod_eori": "string",
"cognome": "string",
"denominazione": "string",
"nome": "string",
"titolo": "string"
},
"codice_fiscale": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
}
},
"rappresentante_fiscale": {"cognome": "string",
"denominazione": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
},
"nome": "string"
},
"sede": {"cap": "string",
"comune": "string",
"indirizzo": "string",
"nazione": "string",
"numero_civico": "string",
"provincia": "string"
},
"stabile_organizzazione": {"cap": "string",
"comune": "string",
"indirizzo": "string",
"nazione": "string",
"numero_civico": "string",
"provincia": "string"
}
},
"dati_trasmissione": {"codice_destinatario": "string",
"contatti_trasmittente": {"email": "string",
"telefono": "string"
},
"formato_trasmissione": "FPA12",
"id_trasmittente": {"id_codice": "string",
"id_paese": "string"
},
"pec_destinatario": "string",
"progressivo_invio": "string"
},
"rappresentante_fiscale": {"dati_anagrafici": {"anagrafica": {"cod_eori": "string",
"cognome": "string",
"denominazione": "string",
"nome": "string",
"titolo": "string"
},
"codice_fiscale": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
}
}
},
"soggetto_emittente": "CC",
"terzo_intermediario_o_soggetto_emittente": {"dati_anagrafici": {"anagrafica": {"cod_eori": "string",
"cognome": "string",
"denominazione": "string",
"nome": "string",
"titolo": "string"
},
"codice_fiscale": "string",
"id_fiscale_iva": {"id_codice": "string",
"id_paese": "string"
}
}
}
},
"namespace": "string",
"sistema_emittente": "string",
"versione": "FPA12"
},
"xml_url": "string"
}
}

Send an invoice courtesy copy through email

Send an invoice courtesy copy through email to some recipient provided in the request body.

The email will contain a link to the actual invoice and maybe contain a personalized body and subject. If these are not provided, the email will contain a default body and subject.

If the response is successful, the email will be sent to the recipient but we do not guarantee that the email will be delivered successfully. The success of the response means that the system has accepted the request and will attempt to send the email.

Authorizations:

None

path Parameters

company_id required	string The company where to execute the operation
document_id required	string The document identifier

Request Body schema: application/json
optional

Request

body	string The body of the email. If not provided, a default body will be used: in Italian: Buongiorno, abbiamo provveduto all'invio della {INVOICE_TYPE} n. {INVOICE_NUMBER}. È possibile visualizzarla o scaricarne una copia in versione PDF cliccando sul bottone sottostante. Grazie e buon lavoro
reply_to required	string <email> non-empty
subject	string The subject of the email. If not provided, a default subject will be used: in Italian: Nostra {INVOICE_TYPE} n. {INVOICE_NUMBER}
required	string or Array of strings

Responses

Request samples

Content type

application/json

{"body": "string",
"reply_to": "user@example.com",
"subject": "string",
"to": "user@example.com"
}

Response samples

400
401
403
404
422

Content type

application/json

{"errors": [{"code": "bad_request",
"detail": "null value where string expected",
"source": {"pointer": "/data/attributes/name"
},
"title": "Invalid value"
}
]
}

Delete an existing document

Authorizations:

None

path Parameters

company_id required	string The company where to execute the operation
id required	string The document identifier

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request DELETE \
     --url ${base_url}/api/v1/companies/:company_id/documents/:document_id \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

401
403
404

Content type

application/json

{"errors": [{"code": "bad_request",
"detail": "null value where string expected",
"source": {"pointer": "/data/attributes/name"
},
"title": "Invalid value"
}
]
}

Get a document

Returns all the information for a specific document from its identifier

Authorizations:

None

path Parameters

company_id required	string The company the document belongs to
id required	string The document identifier

query Parameters

expand

string

Fields that will be expanded. Expandable fields: category, counterpart, flows, subcategory

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/documents/:document_id \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
401
403
404

Content type

application/json

{"data": {"category": {"id": "019dfbe1-d0d7-78e8-b987-5058e3ed5fed",
"name": "string"
},
"counterpart": {"address": "string",
"city": "string",
"company_name": "string",
"country": "string",
"destination_code": "string",
"id": "019dfbe1-cfdf-79e9-9127-e143b5d9b08e",
"postal_code": "string",
"province_code": "string",
"tax_number": "string",
"vat_number": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"creation_date": "2019-08-24",
"delivery_date": "string",
"delivery_status": "string",
"direction": "ISSUED",
"file_name": "string",
"flows": [{"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
}
],
"format": "FPA12",
"gross_amount": {"amount": "12.3",
"currency": "EUR"
},
"id": "019dfbe1-d0d7-7564-9e1d-a9c29cd9f878",
"is_e_invoice": true,
"notes": "string",
"number": "string",
"status": "DRAFT",
"subcategory": {"id": "019dfbe1-d0d7-744f-9e57-83f25ff5827f",
"name": "string"
},
"type": "BILL",
"updated_at": "2019-08-24T14:15:22Z",
"vat_amount": {"amount": "12.3",
"currency": "EUR"
}
}
}

Update an existing document

Authorizations:

None

path Parameters

company_id required	string The company where to execute the operation
id required	string The document identifier

query Parameters

expand

string

Fields that will be expanded. Expandable fields: category, counterpart, flows, subcategory

Request Body schema: application/json
optional

Document

category_id	string or null <uuid> The category identifier
notes	string or null <= 1000 characters Document notes (max 1000 characters)

Responses

Request samples

Content type

application/json

{"category_id": "019dfbe1-d1c8-7c0f-9108-17ffc226bd69",
"notes": "string"
}

Response samples

Content type

application/json

{"data": {"category": {"id": "019dfbe1-d0d7-78e8-b987-5058e3ed5fed",
"name": "string"
},
"counterpart": {"address": "string",
"city": "string",
"company_name": "string",
"country": "string",
"destination_code": "string",
"id": "019dfbe1-cfdf-79e9-9127-e143b5d9b08e",
"postal_code": "string",
"province_code": "string",
"tax_number": "string",
"vat_number": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"creation_date": "2019-08-24",
"delivery_date": "string",
"delivery_status": "string",
"direction": "ISSUED",
"file_name": "string",
"flows": [{"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
}
],
"format": "FPA12",
"gross_amount": {"amount": "12.3",
"currency": "EUR"
},
"id": "019dfbe1-d0d7-7564-9e1d-a9c29cd9f878",
"is_e_invoice": true,
"notes": "string",
"number": "string",
"status": "DRAFT",
"subcategory": {"id": "019dfbe1-d0d7-744f-9e57-83f25ff5827f",
"name": "string"
},
"type": "BILL",
"updated_at": "2019-08-24T14:15:22Z",
"vat_amount": {"amount": "12.3",
"currency": "EUR"
}
}
}

Flow

Get the list of flows for the given document

The return value is paginated. By default the response contains 25 elements per page but can be instructed to return more elements per page. A cursor is needed to traverse the results.

Authorizations:

None

path Parameters

company_id required	string The company the flows belongs to
document_id required	string The document identifier

query Parameters

page_size	integer The page size
cursor	string The pagination cursor. A cursor is used to paginate through a large set of data. It is a unique identifier that represents a specific position in the dataset.

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/documents/:document_id/flows \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
401
403
404

Content type

application/json

{"data": [{"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
}
],
"page": {"cursor": "string",
"size": 0
}
}

Get a specific flow for the document

Authorizations:

None

path Parameters

company_id required	string The company the flow belongs to
document_id required	string The document identifier
id required	string The flow identifier

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/documents/:document_id/flows/:flow_id \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
401
403
404

Content type

application/json

{"data": {"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
}
}

Update an existing flow

Authorizations:

None

path Parameters

company_id required	string The company where to execute the operation
document_id required	string The document identifier
id required	string The flow identifier

Request Body schema: application/json
optional

Flow

	object Money representation through amount and currency properties
expected_payment_date	string <date> The date when the flow is due
payment_date	string <date> The date when the flow was paid
payment_method	string or null Enum: "CARD" "CASH" "CHECK" "DEFERRED" "TAX_FORM" "FISCAL_CREDIT" "OTHER" "POSTAL" "RIBA" "SDD" "TRANSFER" The payment method
payment_status	string Enum: "PAID" "TO_PAY" The payment status

Responses

Request samples

Content type

application/json

{"amount": {"amount": "12.3",
"currency": "EUR"
},
"expected_payment_date": "2019-08-24",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
}

Response samples

Content type

application/json

{"data": {"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
}
}

Reconciliation

List all the company's reconciliations

The return value is paginated. By default the response contains 25 elements per page but can be instructed to return more elements per page. A cursor is needed to traverse the results.

Authorizations:

None

path Parameters

company_id

required

string

The company the reconciliations belong to

query Parameters

page_size	integer The page size
cursor	string The pagination cursor. A cursor is used to paginate through a large set of data. It is a unique identifier that represents a specific position in the dataset.
expand	string Fields that will be expanded. Expandable fields: `flow`, `transaction`
filter	object List of filters on the resource. Currently the fields that allow to be filtered are: `transaction_id`, `flow_id`, `created_at`
sort	string Fields for which we can order the results. Sortable fields: `created_at`

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/reconciliations \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
400
401
403
500

Content type

application/json

{"data": [{"created_at": "2019-08-24T14:15:22Z",
"flow": {"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
},
"flow_id": "019dfbe1-cff0-7f5b-b48b-e1c236e058e1",
"id": "019dfbe1-cff0-7515-8dad-6d04dbc095a6",
"transaction": {"account_id": "019dfbe1-cf46-7b80-aeb0-a3b3ee76aae9",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"bank_code": "string",
"booking_date_time": "2019-08-24T14:15:22Z",
"category": {"id": "019dfbe1-cf46-7d28-a359-961ce5c0df20",
"name": "string"
},
"clean_description": "string",
"counterpart_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "019dfbe1-cf46-7608-a6fa-71f4ea59b5fb",
"reconciliations": [{ }
],
"subcategory": {"id": "019dfbe1-cf46-7093-9db6-7d3b4ac28db5",
"name": "string"
},
"value_date_time": "2019-08-24T14:15:22Z"
},
"transaction_id": "019dfbe1-cff0-79c0-a7ef-fa5c32374bb4"
}
],
"page": {"cursor": "string",
"size": 0
}
}

Create a new reconciliation

Create a new reconciliation between a flow and a bank transaction.

Authorizations:

None

path Parameters

company_id

required

string

The company where to execute the operation

query Parameters

expand

string

Fields that will be expanded. Expandable fields: flow, transaction

Request Body schema: application/json
optional

Reconciliation

flow_id required	string <uuid> The ID of the relative flow
transaction_id required	string <uuid> The ID of the relative transaction

Responses

Request samples

Content type

application/json

{"flow_id": "019dfbe1-d065-776e-82ff-b1d2e54c860e",
"transaction_id": "019dfbe1-d065-7128-a7f4-47a4ba64310f"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"flow": {"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
},
"flow_id": "019dfbe1-cff0-7f5b-b48b-e1c236e058e1",
"id": "019dfbe1-cff0-7515-8dad-6d04dbc095a6",
"transaction": {"account_id": "019dfbe1-cf46-7b80-aeb0-a3b3ee76aae9",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"bank_code": "string",
"booking_date_time": "2019-08-24T14:15:22Z",
"category": {"id": "019dfbe1-cf46-7d28-a359-961ce5c0df20",
"name": "string"
},
"clean_description": "string",
"counterpart_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "019dfbe1-cf46-7608-a6fa-71f4ea59b5fb",
"reconciliations": [{ }
],
"subcategory": {"id": "019dfbe1-cf46-7093-9db6-7d3b4ac28db5",
"name": "string"
},
"value_date_time": "2019-08-24T14:15:22Z"
},
"transaction_id": "019dfbe1-cff0-79c0-a7ef-fa5c32374bb4"
}
}

Delete an existing reconciliation

Authorizations:

None

path Parameters

company_id required	string The company where to execute the operation
id required	string The reconciliation identifier

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request DELETE \
     --url ${base_url}/api/v1/companies/:company_id/reconciliations/:id \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

401
403
404

Content type

application/json

{"errors": [{"code": "bad_request",
"detail": "null value where string expected",
"source": {"pointer": "/data/attributes/name"
},
"title": "Invalid value"
}
]
}

Get a specific reconciliation

Authorizations:

None

path Parameters

company_id required	string The company the reconciliation belongs to
id required	string The reconciliation identifier

query Parameters

expand

string

Fields that will be expanded. Expandable fields: flow, transaction

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/reconciliations/:id \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
401
403
404

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"flow": {"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
},
"flow_id": "019dfbe1-cff0-7f5b-b48b-e1c236e058e1",
"id": "019dfbe1-cff0-7515-8dad-6d04dbc095a6",
"transaction": {"account_id": "019dfbe1-cf46-7b80-aeb0-a3b3ee76aae9",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"bank_code": "string",
"booking_date_time": "2019-08-24T14:15:22Z",
"category": {"id": "019dfbe1-cf46-7d28-a359-961ce5c0df20",
"name": "string"
},
"clean_description": "string",
"counterpart_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "019dfbe1-cf46-7608-a6fa-71f4ea59b5fb",
"reconciliations": [{ }
],
"subcategory": {"id": "019dfbe1-cf46-7093-9db6-7d3b4ac28db5",
"name": "string"
},
"value_date_time": "2019-08-24T14:15:22Z"
},
"transaction_id": "019dfbe1-cff0-79c0-a7ef-fa5c32374bb4"
}
}

Transaction

List all transactions for the company

The return value is paginated. By default the response contains 25 elements per page but can be instructed to return more elements per page. A cursor is needed to traverse the results.

Authorizations:

None

path Parameters

company_id

required

string

The company the transactions belong to

query Parameters

page_size	integer The page size
cursor	string The pagination cursor. A cursor is used to paginate through a large set of data. It is a unique identifier that represents a specific position in the dataset.
expand	string Fields that will be expanded. Expandable fields: `category`, `subcategory`, `reconciliations`, `reconciliations.flow`
filter	object List of filters on the resource. Currently the fields that allow to be filtered are: `account_id`, `booking_date_time`, `clean_description`, `counterpart_name`, `date`, `type`
sort	string Fields for which we can order the results. Sortable fields: `amount`, `created_at`, `date`

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/transactions \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
400
401
403
500

Content type

application/json

{"data": [{"account_id": "019dfbe1-cf46-7b80-aeb0-a3b3ee76aae9",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"bank_code": "string",
"booking_date_time": "2019-08-24T14:15:22Z",
"category": {"id": "019dfbe1-cf46-7d28-a359-961ce5c0df20",
"name": "string"
},
"clean_description": "string",
"counterpart_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "019dfbe1-cf46-7608-a6fa-71f4ea59b5fb",
"reconciliations": [{"created_at": "2019-08-24T14:15:22Z",
"flow": {"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
},
"flow_id": "019dfbe1-cff0-7f5b-b48b-e1c236e058e1",
"id": "019dfbe1-cff0-7515-8dad-6d04dbc095a6",
"transaction": { },
"transaction_id": "019dfbe1-cff0-79c0-a7ef-fa5c32374bb4"
}
],
"subcategory": {"id": "019dfbe1-cf46-7093-9db6-7d3b4ac28db5",
"name": "string"
},
"value_date_time": "2019-08-24T14:15:22Z"
}
],
"page": {"cursor": "string",
"size": 0
}
}

Get a transaction

Returns all the information for a specific transaction from its identifier

Authorizations:

None

path Parameters

company_id required	string The company the transaction belongs to
id required	string The transaction identifier

query Parameters

expand

string

Fields that will be expanded. Expandable fields: category, subcategory, reconciliations, reconciliations.flow

Responses

Request samples

base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/transactions/:transaction_id \
     --header "Authorization: Bearer ${authorization_token}"

Response samples

200
401
403
404

Content type

application/json

{"data": {"account_id": "019dfbe1-cf46-7b80-aeb0-a3b3ee76aae9",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"bank_code": "string",
"booking_date_time": "2019-08-24T14:15:22Z",
"category": {"id": "019dfbe1-cf46-7d28-a359-961ce5c0df20",
"name": "string"
},
"clean_description": "string",
"counterpart_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "019dfbe1-cf46-7608-a6fa-71f4ea59b5fb",
"reconciliations": [{"created_at": "2019-08-24T14:15:22Z",
"flow": {"account_id": "019dfbe1-d03e-7ad3-8705-088a82318bf8",
"amount": {"amount": "12.3",
"currency": "EUR"
},
"created_at": "2019-08-24T14:15:22Z",
"document_id": "019dfbe1-d03e-72b3-93b1-ce3370eb2ea6",
"expected_payment_date": "2019-08-24",
"id": "019dfbe1-cf10-7beb-bf3a-2729a04601e5",
"payment_date": "2019-08-24",
"payment_method": "CARD",
"payment_status": "PAID"
},
"flow_id": "019dfbe1-cff0-7f5b-b48b-e1c236e058e1",
"id": "019dfbe1-cff0-7515-8dad-6d04dbc095a6",
"transaction": { },
"transaction_id": "019dfbe1-cff0-79c0-a7ef-fa5c32374bb4"
}
],
"subcategory": {"id": "019dfbe1-cf46-7093-9db6-7d3b4ac28db5",
"name": "string"
},
"value_date_time": "2019-08-24T14:15:22Z"
}
}

Sibill Integration API Beta Version (1.0.0)

API reference (Beta)

Webhook

Document updated event Webhook

Request Body schema: application/jsonrequired

Responses

Request samples

Flow updated event Webhook

Request Body schema: application/jsonrequired

Responses

Request samples

Company

List all the available companies

Authorizations:

query Parameters

Responses

Request samples

Response samples

Account

List all accounts for the company

Authorizations:

path Parameters

query Parameters

Responses

Request samples

Response samples

Get a account

Authorizations:

path Parameters

Responses

Request samples

Response samples

Category

List all categories for the company

Authorizations:

path Parameters

query Parameters

Responses

Request samples

Response samples

Get a category

Authorizations:

path Parameters

Responses

Request samples

Response samples

Counterpart

Get the list of counterparts

Authorizations:

path Parameters

query Parameters

Responses

Request samples

Response samples

Get a specific counterpart

Authorizations:

path Parameters

Responses

Request samples

Response samples

Search counterpart informations

Authorizations:

query Parameters

Responses

Request samples

Response samples

Document

List all the company's documents

Authorizations:

path Parameters

query Parameters

Responses

Request samples

Response samples

Create an invoice and issue it

Authorizations:

path Parameters

query Parameters

header Parameters

Request Body schema: application/jsonapplication/xmlapplication/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema:
application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional