api-docs v5.116.0

API Docs

Table of contents

Billing_Expense

Billing Expense - Delete

Back to top

Delete a specific billing expense

DELETE /billing-expenses/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/billing-expenses/<billing-expense-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt Date

timestamp
createdBy string

account uid
expensedAt Date

timestamp
facility String
type String

payment-negation, payment-negation-void, payment-negation-return
expenseMethod string
reason String
amountCurrency String
amount Number
metadata Object
billingItem string
billingInvoice string
billingPayment string
billingItemCommission string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Billing Expense - Find

Back to top

Get list of billing expenses

GET /billing-expenses

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/billing-expenses" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
billingExpenses[] object[]

array of billingExpense
billingExpenses.id string
billingExpenses.createdAt Date

timestamp
billingExpenses.createdBy string

account uid
billingExpenses.expensedAt Date

timestamp
billingExpenses.facility String
billingExpenses.type String

payment-negation, payment-negation-void, payment-negation-return
billingExpenses.expenseMethod string
billingExpenses.reason String
billingExpenses.amountCurrency String
billingExpenses.amount Number
billingExpenses.metadata Object
billingExpenses.billingItem string
billingExpenses.billingInvoice string
billingExpenses.billingPayment string
billingExpenses.billingItemCommission string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Billing Expense - Get

Back to top

Get a specific billing expense

GET /billing-expenses/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/billing-expenses/<billing-expense-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt Date

timestamp
createdBy string

account uid
expensedAt Date

timestamp
facility String
type String

payment-negation, payment-negation-void, payment-negation-return
expenseMethod string
reason String
amountCurrency String
amount Number
metadata Object
billingItem string
billingInvoice string
billingPayment string
billingItemCommission string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Billing Expense - Patch

Back to top

Update billing expense

PATCH /billing-expenses/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
expensedAt number optional

timestamp
type string Allowed values: payment-negation,payment-negation-void,payment-negation-return
expenseMethod string optional
reason string optional
amountCurrency string optional Default value: PHP
amount number
metadata object optional
billingItem string optional
billingInvoice string optional
billingPayment string optional
billingItemCommission string optional
createdAt number optional

timestamp

Default value: currentTime

Examples

Example usage:

curl "https://yourdomain.com/billing-expenses/<billing-expense-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "reason": "some reason"
  }'

Parameters examples

json - Request-Example

{
  "reason": "some reason"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt Date

timestamp
createdBy string

account uid
expensedAt Date

timestamp
facility String
type String

payment-negation, payment-negation-void, payment-negation-return
expenseMethod string
reason String
amountCurrency String
amount Number
metadata Object
billingItem string
billingInvoice string
billingPayment string
billingItemCommission string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Billing Expense - Post

Back to top

Create billing expense

POST /billing-expenses

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
expensedAt number optional

timestamp
facility string
type string Allowed values: payment-negation,payment-negation-void,payment-negation-return
expenseMethod string optional
reason string optional
amountCurrency string optional Default value: PHP
amount number
metadata object optional
billingItem string optional
billingInvoice string optional
billingPayment string optional
billingItemCommission string optional
createdAt number optional

timestamp

Default value: currentTime

Examples

Example usage:

curl "https://yourdomain.com/billing-expenses" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "facility": "facility-id",
    "type": "payment-negation",
    "amount": 1000
  }'

Parameters examples

json - Request-Example

{
  "facility": "facility-id",
  "type": "payment-negation",
  "amount": 1000
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt Date

timestamp
createdBy string

account uid
expensedAt Date

timestamp
facility String
type String

payment-negation, payment-negation-void, payment-negation-return
expenseMethod string
reason String
amountCurrency String
amount Number
metadata Object
billingItem string
billingInvoice string
billingPayment string
billingItemCommission string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""