API Services

Please consult the API services specification and orchestration.

Services considerations

All API services can be consulted using the Open API Specification (OAS3):

For Tests purposes
API specification of Test environment at API specification
*must use the credentials (user and pw) defined at your SANDBOX registration

For Production
API specification of Production environment at API specification
*must use the credentials (user and pw) defined at Saphety Invoice Network registration

Services

Send electronic invoices using legal format
Use this service to send eletronic invoices in Portuguese legal format CIUS-PT.

Send PDF invoice, by standard email notification
Use this service to sign, store and send PDF invoices. The PDF invoice will be sent by email to your costumer using the predefined content layout.

Send PDF invoice, by customized email notification
Use this service to sign, store and send PDF invoices. The PDF invoice will be sent by email to your costumer using a cutomized contetn layout.

Store PDF invoices
Use this service to sign and store PDF invoices. The PDF invoice will be signed and stored, and not sent to your costumers.

Get invoice status in archive
Use this service to get an invoice status in archive.

Get invoice status transitions in archive
Use this service to get an invoice status transitions in archive.

Get invoice PDF or UBL from archive
Use this service to get invoice formats from archive.

Resend invoice by email notification
Use this service to resend invoices by email notification.

Get integrated destinations
Use this service to get all or filtred integrated destinations.

Get invoice permalinks
Use this service to get an invoice download permalinks.

Get company subscriptions
Use this service to get all your company subscriptions.

Get company subscription features
Use this service to get company subscription features information.

Get company plan information
Use this service to get company plan information.

Get company custom plan information
Use this service to get company custom plan information.