Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Register a new series with the AT for the supplier.

post/apps/at-pt/v1/entry/{silo_entry_id}/series

Path parameters

silo_entry_idstring required

Silo entry ID of the supplier to register the series for.

Example:347c5b04-cde2-11ed-afa1-0242ac120002

Silo entry ID of the supplier to register the series for.

Request body

basestring required

Base code for the series (without the document type prefix).

document_type'FT' | 'FS' | 'FR' | 'ND' | 'NC' | 'RG' | 'GR' | 'GT' required

Document type for the series:

  • FT: Invoice (Fatura)
  • FS: Simplified Invoice (Fatura Simplificada)
  • FR: Invoice-Receipt (Fatura-Recibo)
  • ND: Debit Note (Nota de Débito)
  • NC: Credit Note (Nota de Crédito)
  • RG: Receipt (Recibo)
  • GR: Delivery Note (Guia de Remessa)
  • GT: Waybill (Guia de Transporte)
type'N' | 'F' | 'R' required

Type of the series:

  • N: Normal
  • F: Training (Formação)
  • R: Recovery (Recuperação)

Example request

{
  "base": "SERIES-A",
  "document_type": "FT",
  "type": "N"
}

Response

Series registered successfully.

idstring

Series ID.

codestring

Full series code (document type + base code).

basestring

Base code for the series.

document_typestring

Document type for the series.

typestring

Type of the series.

validation_codestring

AT validation code for the series used to generate ATCUD codes.

Example response

{
  "id": "1d8ab49a-bd14-11ef-925f-325096b39f47",
  "code": "FT SERIES-A",
  "base": "SERIES-A",
  "document_type": "FT",
  "type": "N",
  "validation_code": "AAJFJ3N5YS"
}