To insert a document in FarPay, the POST method is the standard option to delivery invoices in various formats
In this document we will mention all inbound capabilities in the POST Deliveries endpoint, and have a combination of a surface description, and an in depth description of how the delivery is expressed and sent to FarPay.
Insert an invoice
When inserting an invoice to the delivery endpoint following formats are available.
Other documents
Other document types can also be inserted into the deliveries endpoint, and will typically only serve as a supplement to existing formal data.
| Format | Decription | Processing |
|---|---|---|
| OIO UBL Uts | Utility statement, based on the OIO UBL scheme | passthrough |
OIO UBL UTS
The utility document complies with the OIO UBL standard and will be sent as a passthrough in FarPay. However, the XML distribution gateway will perform the necessary validations to ensure a correct and reliable distribution.
Introduction to express an OIO UBL UTS document is found here: OIO UBL UTS
Example delivery
{
"DeliveryType": "uts",
"DeliveryFormat": "oioubluts",
"File": {
"Filename": "UTS_Statement_january.xml",
"Data" : "<base64>"
}
}The delivery is received, and will return with a DeliveryID, the handle to that specific file.