Sign in
latestOpenAPI 3.0.12026-08-1781258463.9 KB

2ecf51b1543e

AFNOR XP Z12-013/FlowService

🇫🇷 Norme · Submit a new flow

Submit a flow. A flow is a single-invoice file, with :

  • an XML/PDF file with the data of the invoice

The flow is created with a flowInfo object, allowing to qualify the flow.

A flow can be :

  • an invoice (CII, UBL, Factur-X,...)

  • a lifecycle (CDAR)

  • or a e-reporting file

post/flow-service/v1/flows

Query parameters

Sha256string byte

The sha256 is the fingerprint of the attached file:

  • if provided in the request: it should be checked once received

  • if not provided in the request: it may be computed and returned in the response

TrackingIdstring

The tracking id is an external identifier and is used to track the flow by the sender

Namestring required

Name of the file

ProcessingRule'B2B' | 'B2BInt' | 'B2C' | 'B2G' | 'B2GInt' | 'OutOfScope' | 'B2GOutOfScope' | 'ArchiveOnly' | 'NotApplicable' | 'Undefined'

  • B2B : e-invoicing

  • B2BInt : International B2B e-reporting

  • B2C : B2C e-reporting

  • B2G : e-invoicing for B2G sales

  • B2GInt

  • OutOfScope : Out of scope (not regulated flow)

  • B2GOutOfScope

  • ArchiveOnly : Archive only, no transmission

  • NotApplicable : Not Applicable

  • Undefined : Not yet defined when in Pending state or unable to define when in Error state

  • B2B : e-invoicing

  • B2BInt : International B2B e-reporting

  • B2C : B2C e-reporting

  • B2G : e-invoicing for B2G sales

  • B2GInt

  • OutOfScope : Out of scope (not regulated flow)

  • B2GOutOfScope

  • ArchiveOnly : Archive only, no transmission

  • NotApplicable : Not Applicable

  • Undefined : Not yet defined when in Pending state or unable to define when in Error state

FlowSyntax'CII' | 'UBL' | 'FacturX' | 'CDAR' | 'FRR' required

Syntax of the original file belonging to a flow

Syntax of the original file belonging to a flow

FlowProfile'Basic' | 'CIUS' | 'ExtendedCTCFR' | 'Undefined'
AdditionalPropertiesobject
Data.CanReadboolean
Data.CanWriteboolean
Data.CanSeekboolean
Data.CanTimeoutboolean
Data.Lengthinteger
Data.Positioninteger
Data.ReadTimeoutinteger
Data.WriteTimeoutinteger
FileNamestring
ContentTypestring

Headers

Request-Idstring uuid
Organization-Idstring

Response

OK

flowIdstring required
submittedAtstring date-time required

The flow submission date and time (the date and time when the flow was created on the system)

This property should be used by the API consumer as a time reference to avoid clock synchronization issues

sha256string byte nullable

The sha256 is the fingerprint of the attached file:

  • if provided in the request: it should be checked once received

  • if not provided in the request: it may be computed and returned in the response