Create an invoice

post https://api.piriod.com/invoices/

This endpoint creates an invoice for a given customer with status draft. After create the invoice use finalize resource for finish invoice.

Body Params

collection_method

string

Defaults to deferred

Method to collect payments of this invoice. Must be automatically or deferred

customer

string

required

ID of related Customer object.

date

required

Closing date of this invoice.

document

string

required

The ID of the document type this subscription should create.

discount

float

A positive number representing the amount or percentage of the discount.

discount_scheme

string

Defaults to %

Can be $ or %. $ apply amount as discount. % apply percentage as discount.

due_date

date

The deadline for the invoice to change from receivable to overdue status in case the customer has not paid.

lines

array of objects

required

List of Invoice Line objects which represents the items for which this invoice is being charged.

lines*

note

string

A simple text with a 100 characters as max length.

references

array of objects

List of Invoice Reference objects which represents the documents with which the issuance of this invoice is supported. For ex. a Purchase Order

references

Response

Language

Credentials


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://api.piriod.com/invoices/ \
3
     --header 'Authorization: Token YOUR_USER_API_KEY' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --header 'x-simple-workspace: YOUR_ORGANIZATION_ID' \
7
     --data '
8
{
9
  "collection_method": "deferred",
10
  "discount_scheme": "%"
11
}
12
'

Choose an example:

application/json

201201