Create Invoice: Buildium

POSThttps://api.propexo.com/v1/invoices/buildium/

Interface	Method
Invoices	POST /bills

Notice

This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.

Authentication

• AuthorizationBearer
  Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

integration_idstringrequired

The Propexo unique identifier for the integration

vendor_idstringrequired

The Propexo unique identifier for the vendor

invoice_datestringrequired
The date of issuance for the invoice
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
due_datestringrequired
The due date associated with the invoice
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
invoice_items object[]required
Array [
financial_account_idstringrequired
The Propexo unique identifier for the financial account
property_idstringrequired
The Propexo unique identifier for the property
total_amount_in_centsintegerrequired
The amount of the invoice item, in cents
Possible values: >= 0
unit_idstring
The Propexo unique identifier for the unit
notesstring
Notes associated with the invoice item
Possible values: <= 240 characters
total_mark_up_amount_in_centsinteger
Mark up amount in cents
Possible values: >= 0
mark_up_percentagenumber
The mark up percentage
Possible values: >= 0 and <= 100
mark_up_typestring
The markup type. If "Percent" is passed in we will use the mark_up_percentage value. If "Amount" is passed in we will use the total_mark_up_amount_in_cents value
Show 2 enum values
PercentAmount
]
descriptionstring

Description of the invoice

invoice_numberstring

The invoice or reference number that the vendor assigned to the service request

service_request_idstring

The Propexo unique identifier for the service request

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired

integration_idstringrequired

The Propexo unique identifier for the integration

vendor_idstringrequired

The Propexo unique identifier for the vendor

invoice_datestring | nullnullablerequired

Show 2 variants

• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$

due_datestring | nullnullablerequired

Show 2 variants

• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$

invoice_items object[]required

Array [

financial_account_idstringrequired

The Propexo unique identifier for the financial account

property_idstringrequired

The Propexo unique identifier for the property

total_amount_in_centsintegerrequired

The amount of the invoice item, in cents

Possible values: >= 0

unit_idstring

The Propexo unique identifier for the unit

notesstring

Notes associated with the invoice item

Possible values: <= 240 characters

total_mark_up_amount_in_centsinteger

Mark up amount in cents

Possible values: >= 0

mark_up_percentagenumber

The mark up percentage

Possible values: >= 0 and <= 100

mark_up_typestring

The markup type. If "Percent" is passed in we will use the mark_up_percentage value. If "Amount" is passed in we will use the total_mark_up_amount_in_cents value

Show 2 enum values

PercentAmount

]

descriptionstring | nullnullablerequired

Description of the invoice

invoice_numberstring | nullnullablerequired

The invoice or reference number that the vendor assigned to the service request

service_request_idstring | nullnullablerequired

The Propexo unique identifier for the service request

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

POST /v1/invoices/buildium/

curl -X POST https://api.propexo.com/v1/invoices/buildium/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string",
  "vendor_id": "string",
  "invoice_date": "2024-07-29T15:51:28.071Z",
  "due_date": "2024-07-29T15:51:28.071Z",
  "invoice_items": [
    {
      "financial_account_id": "string",
      "property_id": "string",
      "total_amount_in_cents": 0,
      "unit_id": "string",
      "notes": "string",
      "total_mark_up_amount_in_cents": 0,
      "mark_up_percentage": 0,
      "mark_up_type": "Percent"
    }
  ]
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "vendor_id": "string",
    "invoice_date": "2024-07-29T15:51:28.071Z",
    "due_date": "2024-07-29T15:51:28.071Z",
    "invoice_items": [
      {
        "financial_account_id": "string",
        "property_id": "string",
        "total_amount_in_cents": 0,
        "unit_id": "string",
        "notes": "string",
        "total_mark_up_amount_in_cents": 0,
        "mark_up_percentage": 0,
        "mark_up_type": "Percent"
      }
    ],
    "description": "string",
    "invoice_number": "string",
    "service_request_id": "string"
  }
}