Sales | Billing

List your invoices as customer or supplier

get

Retrieve all invoices that are billed to your organization by your suppliers or that your organization bills to your customers regarding the 'context' parameter.

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters

customersinteger · int32[]Optional

Filter by one or multiple specific customers (when context is supplier)

suppliersinteger · int32[]Optional

Filter by one or multiple specific suppliers (when context is customer)

startDatestring · date-timeOptional

Filter invoices which have an invoice date after or at this date

endDatestring · date-timeOptional

Filter invoices which have an invoice date before or at this date

contextstring · enumOptional

customer: retrieve items which are invoiced to you by your suppliers | supplier: retrieve items you bill your customers

Possible values:

searchstringOptional

Filter for company names and customer numbers

sortBystringOptional

Sort the items by a given criterion

sortOrderstringOptional

Sort the items in a given order (asc|desc)

offsetinteger · int32Optional

Specifies the index of the first item to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of items to return

Default: 100

Responses

200

OK: List of invoices.

totalinteger · int32Required

400

BadRequest: Query parameters are invalid.

401

Unauthorized: Invalid api key.

403

Forbidden: Resource access denied or resource does not exist anymore.

get/v1/billing/invoices

GET /v1/billing/invoices HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "supplier": {
        "id": 4,
        "name": "foo Inc.",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "customer": {
        "id": 4,
        "name": "foo Inc.",
        "customerNumber": "C00001",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "primarySupplier": {
        "id": 4,
        "name": "foo Inc.",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "created": "2021-09-20T00:00:00Z",
      "dueDate": "2021-09-20T00:00:00Z",
      "invoiceDate": "2021-10-03T00:00:00Z",
      "invoiceId": "INV-20210920-1234",
      "vatId": "DE123456789",
      "transactionId": "9PT64341PC323712B",
      "chargedTo": "IT department",
      "total": 1498.83,
      "totalRecurring": 264.27,
      "totalOneTime": 1234.56,
      "currencyCode": "EUR",
      "items": {
        "total": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "id": 16523,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single invoice by its id

get

Set the input parameter 'context' depending whether the requested invoice is billed by or to your organization.

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

invoiceIdinteger · int32Required

The identifier of the invoice

Query parameters

contextstring · enumRequired

customer: retrieve items which are invoiced to you by your suppliers | supplier: retrieve items you bill your customers

Possible values:

Responses

200

OK: The requested invoice.

createdstring · date-timeRequired

The timestamp of the creation of the invoice.

Example: 2021-09-20T00:00:00Z

dueDatestring · date-time · nullableOptional

The due date of the invoice.

Example: 2021-09-20T00:00:00Z

invoiceDatestring · date-timeOptional

The date on which the invoice was issued.

Example: 2021-10-03T00:00:00Z

invoiceIdstring · nullableOptional

The invoice id given by the supplier.

Example: INV-20210920-1234

vatIdstring · nullableOptional

The Vat ID of the recipient.

Example: DE123456789

transactionIdstring · nullableOptional

The transaction id of the payment.

Example: 9PT64341PC323712B

chargedTostring · nullableOptional

The cost center for the invoice.

Example: IT department

totalnumber · doubleOptional

The total cost of the invoice.

Example: 1498.83

totalRecurringnumber · doubleOptional

The total recurring cost of the invoice.

Example: 264.27

totalOneTimenumber · doubleOptional

The total one time cost of the invoice.

Example: 1234.56

currencyCodestring · nullableOptional

TMP currency code of the invoice. This will always be the default currency of the customer.

Example: EUR

idinteger · int32Required

The id of the invoice.

Example: 16523

400

BadRequest: Query parameters are invalid.

401

Unauthorized: Invalid api key.

403

Forbidden: Resource access denied or resource does not exist anymore.

get/v1/billing/invoices/{invoiceId}

GET /v1/billing/invoices/{invoiceId}?context=customer HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "supplier": {
    "id": 4,
    "name": "foo Inc.",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "customer": {
    "id": 4,
    "name": "foo Inc.",
    "customerNumber": "C00001",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "primarySupplier": {
    "id": 4,
    "name": "foo Inc.",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "created": "2021-09-20T00:00:00Z",
  "dueDate": "2021-09-20T00:00:00Z",
  "invoiceDate": "2021-10-03T00:00:00Z",
  "invoiceId": "INV-20210920-1234",
  "vatId": "DE123456789",
  "transactionId": "9PT64341PC323712B",
  "chargedTo": "IT department",
  "total": 1498.83,
  "totalRecurring": 264.27,
  "totalOneTime": 1234.56,
  "currencyCode": "EUR",
  "items": {
    "total": 1,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "id": 16523,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Generate a PDF report for a specific invoice

get

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

invoiceIdinteger · int32Required

The identifier of the invoice

Query parameters

languagestringOptional

Language of the report

contextstring · enumRequired

customer: retrieve items which are invoiced to you by your suppliers | supplier: retrieve items you bill your customers

Possible values:

Responses

200

application/pdf

string · binaryOptional

400

Bad Request

application/pdf

401

Unauthorized

application/pdf

403

Forbidden

application/pdf

get/v1/billing/invoices/{invoiceId}/reports/invoice

GET /v1/billing/invoices/{invoiceId}/reports/invoice?context=customer HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

binary

Get filtered billing items.

get

Get all billing items that pass the filters within the selected timespan. A billing item is an active service instance that is charged to the customer.

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters

customersinteger · int32[]Optional

Filter by one or multiple specific customers (when context is supplier)

suppliersinteger · int32[]Optional

Filter by one or multiple specific suppliers (when context is customer)

ordersinteger · int32[]Optional

Filter items related to one or multiple specific sales order

resourcesinteger · int32[]Optional

Filter by one or multiple specific resources / service instances

invoicesinteger · int32[]Optional

Filter by one or multiple specific invoices

startDatestring · date-timeOptional

Filter items that started their billing period after or at this date

endDatestring · date-timeOptional

Filter items that started their billing period before or at this date

contextstring · enumOptional

customer: retrieve items which are invoiced to you by your suppliers | supplier: retrieve items you bill your customers

Possible values:

searchstringOptional

Filter for resource id, service name, inventory number, employee first and last name, group or location name

sortBystringOptional

Sort the items by a given criterion

Default: startDate

sortOrderstringOptional

Sort the items in a given order (asc|desc)

Default: desc

offsetinteger · int32Optional

Specifies the index of the first item to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of items to return

Default: 100

Responses

200

OK: List of billing items.

totalinteger · int32Required

400

BadRequest: Query parameters are invalid.

401

Unauthorized: Invalid api key.

403

Forbidden: Resource access denied or resource does not exist anymore.

get/v1/billing/items

GET /v1/billing/items HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "supplier": {
        "id": 4,
        "name": "foo Inc.",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "customer": {
        "id": 4,
        "name": "foo Inc.",
        "customerNumber": "C00001",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "location": {
        "id": 1,
        "name": "HQ New York",
        "type": "location",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "employee": {
        "id": 1,
        "firstName": "Pierce",
        "lastName": "Bell",
        "fullName": "text",
        "email": "p.bell@foo.io",
        "username": "j.doe@foo.inc",
        "costCenter": "4645-2343",
        "costCenterId": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "group": {
        "id": 42,
        "name": "Project 1337",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "service": {
        "id": 4,
        "name": "Basic Plan",
        "category": "text",
        "ean": "0194253408253",
        "externalId": "E54363",
        "supplierName": "text",
        "previewImageLink": "text",
        "type": "service",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "resource": {
        "id": 42,
        "inventoryNumber": "EQ642",
        "costCenter": "4645-2343",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "invoice": {
        "id": 16523,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "type": "fee",
      "cycle": "none",
      "status": "draft",
      "description": "",
      "startDate": "2021-09-20T00:00:00Z",
      "endDate": "2021-10-03T00:00:00Z",
      "costs": 1337,
      "currencyCode": "EUR",
      "id": 16523,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single billing item by its id

get

Set the input parameter 'context' depending whether the requested billing item is billed by or to your organization.

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

itemIdinteger · int64Required

The identifier of the billing item

Query parameters

contextstring · enumRequired

customer: retrieve items which are invoiced to you by your suppliers | supplier: retrieve items you bill your customers

Possible values:

Responses

200

OK: The requested invoice.

typestring · enumRequiredPossible values:

cyclestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

descriptionstring · nullableOptional

The technical charge description.

startDatestring · date-timeRequired

The start date for the charge.

Example: 2021-09-20T00:00:00Z

endDatestring · date-timeOptional

The end date for the charge.

Example: 2021-10-03T00:00:00Z

costsnumber · doubleRequired

Costs that are billed for the resource.

Example: 1337

currencyCodestring · nullableOptional

Gets or sets the ISO 4217 currency code associated with the transaction.

Example: EUR

idinteger · int64Required

The id of the billing item.

Example: 16523

400

BadRequest: Query parameters are invalid.

401

Unauthorized: Invalid api key.

403

Forbidden: Resource access denied or resource does not exist anymore.

get/v1/billing/items/{itemId}

GET /v1/billing/items/{itemId}?context=customer HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "supplier": {
    "id": 4,
    "name": "foo Inc.",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "customer": {
    "id": 4,
    "name": "foo Inc.",
    "customerNumber": "C00001",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "location": {
    "id": 1,
    "name": "HQ New York",
    "type": "location",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "employee": {
    "id": 1,
    "firstName": "Pierce",
    "lastName": "Bell",
    "fullName": "text",
    "email": "p.bell@foo.io",
    "username": "j.doe@foo.inc",
    "costCenter": "4645-2343",
    "costCenterId": 1,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "group": {
    "id": 42,
    "name": "Project 1337",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "service": {
    "id": 4,
    "name": "Basic Plan",
    "category": "text",
    "ean": "0194253408253",
    "externalId": "E54363",
    "supplierName": "text",
    "previewImageLink": "text",
    "type": "service",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "resource": {
    "id": 42,
    "inventoryNumber": "EQ642",
    "costCenter": "4645-2343",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "invoice": {
    "id": 16523,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "type": "fee",
  "cycle": "none",
  "status": "draft",
  "description": "",
  "startDate": "2021-09-20T00:00:00Z",
  "endDate": "2021-10-03T00:00:00Z",
  "costs": 1337,
  "currencyCode": "EUR",
  "id": 16523,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Last updated 1 hour ago

Was this helpful?