API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

bill_lines

Creates a bill_lines resource.

Creates a bill_lines resource.

Authorizations:
JWT
path Parameters
id
required
string

bill_lines identifier

Request Body schema:
required

The new bill_lines resource

timestamp
string <date-time>
priority
integer
bill
string <iri-reference>

Get bill.

code
string or null
scan
string or null

Raw code scanned

price
required
string
discountPrice
required
string
number
required
string
Default: 1

// Quantity by line

taxes
required
boolean
Default: true
taxCustoms
Array of strings <iri-reference> [ items <iri-reference > ]
type
required
string <iri-reference>
product
string or null <iri-reference>

Get Product

description
string or null
discountable
required
boolean
Default: true
owningCorporation
string <iri-reference>
chargingInvoices
Array of strings <iri-reference> [ items <iri-reference > ]
chargingProjects
Array of strings <iri-reference> [ items <iri-reference > ]
chargeable
required
boolean
chargeableAmount
required
string
fiscPercent
required
string
convertedPrice
required
string
notes
string or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customProperties
any

Can contain anything (array, objects, nested objects...).

customData
Array of strings or null
createdAt
string <date-time>
updatedAt
string <date-time>
disabledAt
string or null <date-time>
object (Collection.jsonld)
upload_filename
string
upload_subfolder
string
upload_file
string
upload_file_link
string
number or (unknown_type or null) or (string or null)

Function to set discount prices on line, if applicable.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "priority": 0,
  • "bill": "https://example.com/",
  • "code": "string",
  • "scan": "string",
  • "price": "string",
  • "discountPrice": "string",
  • "number": 1,
  • "taxes": true,
  • "taxCustoms": [],
  • "type": "https://example.com/",
  • "product": "https://example.com/",
  • "description": "string",
  • "discountable": true,
  • "owningCorporation": "https://example.com/",
  • "chargingInvoices": [],
  • "chargingProjects": [],
  • "chargeable": true,
  • "chargeableAmount": "string",
  • "fiscPercent": "string",
  • "convertedPrice": "string",
  • "notes": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": { },
  • "upload_filename": "string",
  • "upload_subfolder": "string",
  • "upload_file": "string",
  • "upload_file_link": "string",
  • "lineDiscountPrice": 0,
  • "upload_Subfolder": "string",
  • "upload_File": "string",
  • "upload_File_Link": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "priority": 0,
  • "bill": {
    },
  • "code": "string",
  • "scan": "string",
  • "price": "string",
  • "discountPrice": "string",
  • "number": 1,
  • "taxes": true,
  • "taxCustoms": [
    ],
  • "type": {
    },
  • "product": {
    },
  • "description": "string",
  • "discountable": true,
  • "owningCorporation": {
    },
  • "chargeable": true,
  • "chargeableAmount": "string",
  • "fiscPercent": "string",
  • "convertedPrice": "string",
  • "notes": "string",
  • "shortcode": "BL",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "chargeablePrice": 0,
  • "chargingInvoicesListing": "string",
  • "chargingProjectsListing": "string",
  • "parent": {
    },
  • "taxable": true,
  • "value": null,
  • "convertedValue": null,
  • "billLineConvertedValue": 0,
  • "displayTitle": null,
  • "billLineDisplayTitle": "string",
  • "displayCode": null,
  • "billLineDisplayCode": "string",
  • "sameSupplierOnProductAndBill": true,
  • "taxableValue": null,
  • "convertedTaxableValue": null,
  • "accountable": true,
  • "customPropertiesListing": "string",
  • "uniqueId": "string",
  • "toString": "string",
  • "total": null,
  • "convertedTotal": null,
  • "correction": null,
  • "originalPrice": 0,
  • "anonymousToken": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}