API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

invoices

Creates a invoices resource.

Creates a invoices resource.

Authorizations:
JWT
path Parameters
id
required
string

invoices identifier

Request Body schema:
required

The new invoices resource

timestamp
string <date-time>
fetchedTaxes
Array of strings
taxes
Array of strings <iri-reference> [ items <iri-reference > ]
date
required
string <date-time>
deliveryDate
string <date-time>
client
required
string <iri-reference>

Get client.

coordinate
string or null <iri-reference>

Get coordinate

project
string or null <iri-reference>

Get project.

employee
required
string <iri-reference>

Get employe.

distributionType
required
string <iri-reference>
type
required
string <iri-reference>
status
required
string <iri-reference>
notes
string or null
conditions
string or null
payments
Array of strings <iri-reference> [ items <iri-reference > ]
lines
Array of strings <iri-reference> [ items <iri-reference > ]

Get Lines

inventoryEntries
Array of strings <iri-reference> [ items <iri-reference > ]
chargedBillLines
Array of strings <iri-reference> [ items <iri-reference > ]
chargedRents
Array of strings <iri-reference> [ items <iri-reference > ]
chargedTimesheets
Array of strings <iri-reference> [ items <iri-reference > ]
chargedAllowances
Array of strings <iri-reference> [ items <iri-reference > ]
followups
Array of strings <iri-reference> [ items <iri-reference > ]

Get Followups

owningCorporation
string <iri-reference>
clientRef
string or null
shipments
Array of strings <iri-reference> [ items <iri-reference > ]
batches
Array of strings <iri-reference> [ items <iri-reference > ]
autoEmail
boolean
autoInterests
boolean
currency
string <iri-reference>
conversionRate
string
Default: 1
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
image
string <iri-reference>
currentTaxes
Array of strings

Used by lineToolBox

employe
integer

Get employe.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{}

Response samples

Content type
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "fetchedTaxes": [
    ],
  • "taxes": [],
  • "date": "2019-08-24T14:15:22Z",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "client": "https://example.com/",
  • "coordinate": "https://example.com/",
  • "project": "https://example.com/",
  • "employee": "https://example.com/",
  • "distributionType": "https://example.com/",
  • "type": "https://example.com/",
  • "status": "https://example.com/",
  • "notes": "string",
  • "conditions": "string",
  • "payments": [],
  • "lines": [],
  • "inventoryEntries": [],
  • "chargedBillLines": [],
  • "chargedRents": [],
  • "chargedTimesheets": [],
  • "chargedAllowances": [],
  • "followups": [],
  • "owningCorporation": "https://example.com/",
  • "clientRef": "string",
  • "shipments": [],
  • "batches": [],
  • "autoEmail": true,
  • "autoInterests": true,
  • "currency": "https://example.com/",
  • "conversionRate": 1,
  • "shortcode": "I",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": {
    },
  • "image": "https://example.com/",
  • "toString": "string",
  • "lateDiff": "string",
  • "lateDiffDays": 0,
  • "total": 0,
  • "invoiceTotal": null,
  • "jMSTaxesAmount": 0,
  • "taxesAmount": 0,
  • "totalPaid": 0,
  • "invoiceTotalPaid": 0,
  • "currentTaxes": [
    ],
  • "taxesCount": 0,
  • "invoiceTaxesCount": 0,
  • "totalToPay": 0,
  • "invoiceTotalToPay": "string",
  • "totalToPayWithoutTaxes": 0,
  • "invoiceTotalToPayWithoutTaxes": 0,
  • "subTotal": 0,
  • "invoiceSubTotal": 0,
  • "convertedSubTotal": 0,
  • "convertedTaxesAmount": 0,
  • "convertedTotal": 0,
  • "invoiceConvertedSubTotal": 0,
  • "invoiceConvertedTotal": 0,
  • "invoiceConvertedTaxesAmount": 0,
  • "productSubTotal": 0,
  • "invoiceProductSubTotal": 0,
  • "convertedProductSubTotal": 0,
  • "invoiceConvertedProductSubtotal": 0,
  • "totalItemsQuantity": 0,
  • "invoiceItemsQuantity": 0,
  • "totalInventoryQuantity": 0,
  • "invoiceTotalInventoryQuantity": 0,
  • "nbProducts": 0,
  • "nbProductsCountedInInventory": 0,
  • "invoiceNbProducts": 0,
  • "anonymousToken": "string",
  • "currentCoordinate": null,
  • "currentLocation": null,
  • "paymentTime": 0,
  • "plannedDeliveryTime": "2019-08-24T14:15:22Z",
  • "taxesListing": "string",
  • "taxesFetchable": true,
  • "taxesOverrited": true,
  • "personOFInterest": "https://example.com/",
  • "linesListing": "string",
  • "inventoryEntriesListing": "string",
  • "paymentsListing": "string",
  • "followupsListing": "string",
  • "shipmentsListing": "string",
  • "batchesListing": "string",
  • "apiShortname": "string",
  • "lineNumber": 0,
  • "valuedInventory": [
    ],
  • "baseTransactionValuedInventory": [
    ],
  • "employe": 0,
  • "paid": true,
  • "convertedTotalPaid": 0,
  • "convertedTotalToPay": 0,
  • "nbItems": 0,
  • "convertedTaxableAmount": 0,
  • "taxableAmount": 0,
  • "taxableDate": "2019-08-24T14:15:22Z",
  • "taxableState": "string",
  • "accountable": true,
  • "fullEntityString": "string",
  • "tokenString": "string",
  • "entityMetatadaEndpoint": "string",
  • "filesListing": "string",
  • "modificationHistoryListing": "string",
  • "notesListing": "string",
  • "ownershipsListing": "string",
  • "approvalsListing": "string",
  • "tableName": "string",
  • "fQCN": "string",
  • "uniqueId": "string",
  • "apiCustomData": null,
  • "deleted": true,
  • "taggableType": "string",
  • "taggableId": 0,
  • "taggingListing": "string",
  • "enabled": true,
  • "enabledVirtual": true,
  • "disabled": true,
  • "entityStorageFolder": "string",
  • "subtotal": 0
}