All docs This doc
Skip to end of metadata
Go to start of metadata


Overview

The following operations allow you to work with delivery notes. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with delivery notes, see Sample configuration

OperationDescription

createDeliveryNote

Creates a new delivery note.

getDeliveryNote

Retrieves a specific delivery note by its ID.

listDeliveryNotesRetrieves all delivery notes.

Operation details

This section provides further details on the operations related to delivery notes.

Creating a delivery note

The createDeliveryNote operation creates a new delivery note.

createDeliveryNote
<billomat.createDeliveryNote>
    <numberPre>{$ctx:numberPre}</numberPre>
    <number>{$ctx:number}</number>
    <numberLength>{$ctx:numberLength}</numberLength>
    <clientId>{$ctx:clientId}</clientId>
    <contactId>{$ctx:contactId}</contactId>
    <address>{$ctx:address}</address>
    <date>{$ctx:date}</date>
    <title>{$ctx:title}</title>
    <label>{$ctx:label}</label>
    <introduction>{$ctx:introduction}</introduction>
    <note>{$ctx:note}</note>
    <offerId>{$ctx:offerId}</offerId>
    <confirmationId>{$ctx:confirmationId}</confirmationId>
    <invoiceId>{$ctx:invoiceId}</invoiceId>
	<deliveryNoteItems>{$ctx:deliveryNoteItems}</deliveryNoteItems>
</billomat.createDeliveryNote>
Properties
  • numberPre: Prefix for the number of the delivery note.
  • number: The serial number of the delivery note.
  • numberLength: The minimum length of the delivery note number.
  • clientId: The ID of the client.
  • contactId: The ID of the contact.
  • address: The delivery address of the client.
  • date: The date of the delivery note.
  • title: The title of the delivery note.
  • label: The label to describe the delivery note.
  • introduction: The introduction of the delivery note.
  • note: Explanatory note for the delivery note.
  • offerId: The offer ID of the delivery note.
  • confirmationId: The ID of the confirmation, if the delivery note was created from a confirmation.
  • invoiceId: The ID of the invoice, if the delivery note was created from an invoice.
  • deliveryNoteItems: An array of items to be delivered.
   Sample request

Following is a sample REST/JSON request that can be handled by the createDeliveryNote operation.

Sample Request for createDeliveryNote
{
    "format": "json",
    "numberPre": "DN",
    "number": "1232",
    "note": "test 1221",
    "introduction": "Delivery is noted",
    "label": "D11",
    "clientId": "644869",
    "apiUrl": "https://mycompany.billomat.net",
    "apiKey": "2c164e2cef537ac9dd5863ae32de2d45",
    "invoiceId": "1490406",
    "deliveryNoteItems": {
        "delivery-note-item": [
            {
                "unit": "USD",
                "quantity": "20",
                "unit_price": "12",
                "title": "Mars"
            },
            {
                "unit": "USD",
                "quantity": "20",
                "unit_price": "32",
                "title": "Snickers"
            }
        ]
    },
    "title": "Chocolate Delivery",
    "date": "2015-09-25",
    "contactId": "66878",
    "address": "858/5, Thalangama North,Malabe",
    "confirmationId": "3445",
    "offerId": "5657"
}
Related Billomat documentation

http://www.billomat.com/en/api/delivery-notes

Retrieving a specific delivery note by its ID

The getDeliveryNote operation retrieves a specific delivery note by its ID.

getDeliveryNote
<billomat.getDeliveryNote>
	<deliveryNoteId>{$ctx:deliveryNoteId}</deliveryNoteId>
</billomat.getDeliveryNote>
Properties
  • deliveryNoteId: The ID of the delivery note from which the details need to be retrieved.
   Sample request

Following is a sample REST/JSON request that can be handled by the getDeliveryNote operation.

Sample Request for getDeliveryNote
{
    "deliveryNoteId": "52771",
    "format":"json",
    "apiUrl": "https://mycompany.billomat.net",
    "apiKey": "2c164e2cef537ac9dd5863ae32de2d45"
}
Related Billomat documentation

http://www.billomat.com/en/api/delivery-notes

Retrieving all delivery notes

The listDeliveryNotes operation retrieves all delivery notes.

listDeliveryNotes
<billomat.listDeliveryNotes>
    <deliveryNoteNumber>{$ctx:deliveryNoteNumber}</deliveryNoteNumber>
    <to>{$ctx:to}</to>
    <tags>{$ctx:tags}</tags>
    <orderBy>{$ctx:orderBy}</orderBy>
    <status>{$ctx:status}</status>
    <label>{$ctx:label}</label>
    <from>{$ctx:from}</from>
    <perPage>{$ctx:perPage}</perPage>
    <articleId>{$ctx:articleId}</articleId>
    <clientId>{$ctx:clientId}</clientId>
    <contactId>{$ctx:contactId}</contactId>
    <page>{$ctx:page}</page>
    <introduction>{$ctx:introduction}</introduction>
	<note>{$ctx:note}</note>
</billomat.listDeliveryNotes>
Properties
  • deliveryNoteNumber: Filter results by delivery note numbers.
  • to: Only show delivery notes up to this date (format YYYY-MM-DD)
  • tags: Comma separated list of tags.
  • orderBy: Sorting orders to retrieve delivery notes.
  • status: Status (DRAFT, CREATED). More than one statuses could be given as a comma separated list. Theses statuses will be logically or connected.
  • label: Filter results by label.
  • from: Only show delivery notes since this date (format YYYY-MM-DD)
  • perPage: Number of entries to return per page when results are paginated.
  • articleId: The ID of an article.
  • clientId: Filter results by client ID.
  • contactId: Filter results by contact ID.
  • page: Number of the page to return. Applies for paginated response.
  • introduction: Filter results by introduction.
  • note: Filter results by notes.
   Sample request

Following is a sample REST/JSON request that can be handled by the listDeliveryNotes operation.

Sample Request for listDeliveryNotes
{
	"apiUrl": "https://mycompany.billomat.net",
	"apiKey": "2c164e2cef537ac9dd5863ae32de2d45",
	"format":"json",
	"deliveryNoteNumber":"DN123",
	"to":"2015-09-20",
	"tags":"tag12",
	"orderBy":"client_id",
	"status":"Draft",
	"label":"DN",
	"from":"2015-09-08",
	"perPage":"1",
	"articleId":"12",
	"clientId":"1121",
	"contactId":"121",
	"page":"2",
	"introduction":"Goods delivered",
	"note":"Explanatory notes"
}
Related Billomat documentation

http://www.billomat.com/en/api/delivery-notes

Sample configuration

Following is a sample proxy service that illustrates how to connect to Billomat with the init operation and use the createDeliveryNote operation. The sample request for this proxy can be found in the createDeliveryNote sample request.

Sample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy name="billomat_createDeliveryNote" startOnLoad="true" statistics="disable" trace="disable" transports="https,http" xmlns="http://ws.apache.org/ns/synapse">
   <target>
      <inSequence onError="faultHandlerSeq">
         <property name="apiUrl" expression="json-eval($.apiUrl)"/>
         <property name="apiKey" expression="json-eval($.apiKey)"/>
         <property name="numberPre" expression="json-eval($.numberPre)"/>
         <property name="number" expression="json-eval($.number)"/>
         <property name="numberLength" expression="json-eval($.numberLength)"/>
         <property name="clientId" expression="json-eval($.clientId)"/>
         <property name="contactId" expression="json-eval($.contactId)"/>
         <property name="address" expression="json-eval($.address)"/>
         <property name="date" expression="json-eval($.date)"/>
         <property name="title" expression="json-eval($.title)"/>
         <property name="label" expression="json-eval($.label)"/>
         <property name="introduction" expression="json-eval($.introduction)"/>
         <property name="note" expression="json-eval($.note)"/>
         <property name="offerId" expression="json-eval($.offerId)"/>
         <property name="confirmationId" expression="json-eval($.confirmationId)"/>
         <property name="invoiceId" expression="json-eval($.invoiceId)"/>
         <property name="deliveryNoteItems" expression="json-eval($.deliveryNoteItems)"/>
         <property name="format" expression="json-eval($.format)"/>
         <billomat.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <apiKey>{$ctx:apiKey}</apiKey>
            <format>{$ctx:format}</format>
         </billomat.init>
         <billomat.createDeliveryNote>
            <numberPre>{$ctx:numberPre}</numberPre>
            <number>{$ctx:number}</number>
            <numberLength>{$ctx:numberLength}</numberLength>
            <clientId>{$ctx:clientId}</clientId>
            <contactId>{$ctx:contactId}</contactId>
            <address>{$ctx:address}</address>
            <date>{$ctx:date}</date>
            <title>{$ctx:title}</title>
            <label>{$ctx:label}</label>
            <introduction>{$ctx:introduction}</introduction>
            <note>{$ctx:note}</note>
            <offerId>{$ctx:offerId}</offerId>
            <confirmationId>{$ctx:confirmationId}</confirmationId>
            <invoiceId>{$ctx:invoiceId}</invoiceId>
            <deliveryNoteItems>{$ctx:deliveryNoteItems}</deliveryNoteItems>
         </billomat.createDeliveryNote>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>
  • No labels