List of received invoices

get

https://app-staging.b2brouter.net/projects/{account}/received.{format}

Returns a paginated list of your received invoices.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account

string

required

Account identifier (ID)

format

string

enum

required

Format

The format of the API response can be either JSON or XML.

Allowed:

Query Params

offset

integer

Defaults to 0

Jump to the first object.

limit

integer

Defaults to 25

Number of items in the response (500 maximum)

ack

boolean

Filter documents with ACK.

date_from

date

Filter from submission date.

date_to

date

Filter to submission date

due_date_from

date

Filter from due date

due_date_to

date

Filter to due date

number

string

Filter on invoice number. Performs an exact match search; only invoices with an invoice number exactly equal to the specified value will be returned

state_updated_at_from

date

Filter on change status date. Invoices with change status date later than the specified date are returned

updated_at_from

date

Filter on updated_at date. Entities with updated_at date later than the specified date are returned.

taxcode

string

deprecated

Filter on customer VAT code

new

integer

enum

0 to 1

Filter on received invoices with status "new".

Allowed:

received

integer

enum

0 to 1

Filter on received invoices with status "received".

Allowed:

error

integer

enum

0 to 1

Filter on received invoices with status "error".

Allowed:

discarded

integer

enum

0 to 1

deprecated

Filter on received invoices with status "discarded".

Allowed:

paid

integer

enum

0 to 1

Filter on received invoices with status "paid".

Allowed:

refused

integer

enum

0 to 1

Filter on received invoices with status "refused".

Allowed:

annotated

integer

enum

0 to 1

Filter on received invoices with status "annotated".

Allowed:

closed

integer

enum

0 to 1

Filter on received invoices with status "invalid".

Allowed:

ocr_failed

integer

enum

0 to 1

Filter on received invoices with status "ocr_failed".

Allowed:

accepted

integer

enum

0 to 1

Filter on received invoices with status "accepted".

Allowed:

exclude_offices

integer

enum

0 to 1

Do not show the invoices of the Organizational Units.

Allowed:

from_net

string

Filter on received invoice from net value. Use as a string search, for example, searching "api" lists all the received invoices that are received via API.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

200Successful operation