Billit

Ocp

Endpoint

List OCP links

GET

https://api.sandbox-billit.xyz/v1

/ocps

Get a list of ocp links

List OCP links › query Parameters

per_pagestring
Set the results per page limit. Default is 25.
Example: 100

List OCP links › Headers

Acceptstring
application/json

List OCP links › Responses

dataobject
linksobject
metaobject

Create a new OCP link

POST

https://api.sandbox-billit.xyz/v1

/ocps

Create a new OCP ( One click payment ) link.

You really need to setup an online payment method first through the Billit UI.

Make sure to use a payment method sandbox account as well to avoid real charges while testing.

Create a new OCP link › Headers

Acceptstring
application/json

Create a new OCP link › Request Body

titlestring · required
The title of the link
costnumber · required
The final cost, the payable amount.
invoiceTypeIdnumber · required
Select the invoicetype ID that you want to the resulting invoice
netValuenumber · required
Fill in the net value of the link
vatIdnumber · required
Select the Vat ID that will be applied
paymentMethodIdnumber · required
You need to select the payment method ID that will be used.
langstring · enum · minLength: 1 · required
Select the default language of the OCP link form
Enum values:
el
en
Example: el
expirationAtstring · minLength: 1 · required
The date in ISO format

descriptionstring
A more descriptive text on what this is about.
customerIdnumber
Optionaly, if you know the customer fill in his ID. It will be used as the receiver in the invoice
productIdnumber
Optionaly, you can select the product ID to be selected as product in the resulting invoice

Create a new OCP link › Responses

Created

dataobject

Show an OCP link

GET

https://api.sandbox-billit.xyz/v1

/ocps/{uuid}

Show an ocp link

Show an OCP link › path Parameters

uuidstring · required

Show an OCP link › Headers

Acceptstring
application/json

Show an OCP link › Responses

dataobject

Update OCP link

PUT

https://api.sandbox-billit.xyz/v1

/ocps/{uuid}

Update an OCP link

Update OCP link › path Parameters

uuidstring · required

Update OCP link › Headers

Acceptstring
application/json

Update OCP link › Request Body

titlestring · minLength: 1 · required
The title of the ocp link
descriptionstring · minLength: 1 · required
A more descriptive text for the ocp link
costnumber · required
The total cost of the link
netValuenumber · required
The net value of the link
paymentMethodIdnumber · required
The payment method ID
langstring · minLength: 1 · required
The language of the link, "el" or "en"

customerIdnumber
The customer ID if you want to link to a certain one.
invoiceTypeIdnumber
The invoicetype ID that will be generated afterwards
vatIdnumber
The Vat ID
productIdnumber
The product ID if used
expirationAtstring · minLength: 1

Update OCP link › Responses

dataobject

Delete OCP link

DELETE

https://api.sandbox-billit.xyz/v1

/ocps/{uuid}

Delete an OCP link

Delete OCP link › path Parameters

uuidstring · required

Delete OCP link › Headers

Acceptstring
application/json

Delete OCP link › Responses

No data returned

Products Payments

List OCP links

GET

https://api.sandbox-billit.xyz/v1

/ocps

Get a list of ocp links

List OCP links › query Parameters

per_pagestring
Set the results per page limit. Default is 25.
Example: 100

List OCP links › Headers

Acceptstring
application/json

List OCP links › Responses

dataobject
linksobject
metaobject

Create a new OCP link

POST

https://api.sandbox-billit.xyz/v1

/ocps

Create a new OCP ( One click payment ) link.

You really need to setup an online payment method first through the Billit UI.

Make sure to use a payment method sandbox account as well to avoid real charges while testing.

Create a new OCP link › Headers

Acceptstring
application/json

Create a new OCP link › Request Body

titlestring · required
The title of the link
costnumber · required
The final cost, the payable amount.
invoiceTypeIdnumber · required
Select the invoicetype ID that you want to the resulting invoice
netValuenumber · required
Fill in the net value of the link
vatIdnumber · required
Select the Vat ID that will be applied
paymentMethodIdnumber · required
You need to select the payment method ID that will be used.
langstring · enum · minLength: 1 · required
Select the default language of the OCP link form
Enum values:
el
en
Example: el
expirationAtstring · minLength: 1 · required
The date in ISO format

descriptionstring
A more descriptive text on what this is about.
customerIdnumber
Optionaly, if you know the customer fill in his ID. It will be used as the receiver in the invoice
productIdnumber
Optionaly, you can select the product ID to be selected as product in the resulting invoice

Create a new OCP link › Responses

Created

dataobject

Update OCP link

PUT

https://api.sandbox-billit.xyz/v1

/ocps/{uuid}

Update an OCP link

Update OCP link › path Parameters

uuidstring · required

Update OCP link › Headers

Acceptstring
application/json

Update OCP link › Request Body

titlestring · minLength: 1 · required
The title of the ocp link
descriptionstring · minLength: 1 · required
A more descriptive text for the ocp link
costnumber · required
The total cost of the link
netValuenumber · required
The net value of the link
paymentMethodIdnumber · required
The payment method ID
langstring · minLength: 1 · required
The language of the link, "el" or "en"

customerIdnumber
The customer ID if you want to link to a certain one.
invoiceTypeIdnumber
The invoicetype ID that will be generated afterwards
vatIdnumber
The Vat ID
productIdnumber
The product ID if used
expirationAtstring · minLength: 1

Update OCP link › Responses

dataobject