Get a contact (client/provider)

get https://app-staging.b2brouter.net/clients/{id}.{format}

Returns a client entity

Responses

Response body

object

client

object

Client object with required attributes

integer

Internal ID

taxcode

string

required

length ≤ 255

TaxCode. The Buyer's VAT identifier (also known as Buyer VAT identification number).
Can be prefixed by a scheme code followed by a colon.

ID: BT-48

name

string

required

length ≤ 255

Name

string

length ≤ 255

phone

string | null

Phone

website

string | null

Website

address

string | null

Address

address2

string | null

Address 2

postalcode

string

length ≤ 255

Postcode

city

string | null

City

province

string | null

Region/Province/County

country

string

required

length ≤ 255

Country

language

string

length ≤ 2

Defaults to en

Contact language. It should be a language available inside B2Brouter.
You can check all available languages using the Languages endpoint (/users/languages.json)

en es ca fr it de pt nl pl da sv ar

currency

string

length ≤ 255

Default currency for the electronic documents related to this contact.
You can check all supported currencies using the Currencies endpoint (/users/currencies.json)

is_client

boolean

Defaults to true

Indicates if the contact is a client for your organisation

is_provider

boolean

Defaults to false

Indicates if the contact is a provider for your organisation

invoice_format

string | null

deprecated

Method for sending invoices. Now can be used the combination of fields transport_type_code and document_type_code

transport_type

string | null

deprecated

An internal identifier that is unique to each Transport Type within B2Brouter.
You can get all valid transport type codes using the Transport Types endpoint (/users/transport_types.{format}).

document_type

string | null

deprecated

An internal identifier that is unique to each Document Type within B2Brouter.
You can get all valid document type codes using the Document Types endpoint (/users/document_types.{format}).

cin_value

string | null

Company Identifier Number

cin_scheme

string | null

The scheme identifier of Company Identifier Number (not a tax identifier number).
You can get all schemes codes using the *Schemes endpoint (/users/schemes.{format}).

pin_value

string | null

Peppol Identifier Number, identifies the Buyer's electronic address to which the invoice is delivered.

pin_scheme

string | null

The identification scheme identifier of the Buyer electronic address.

You can get all schemes codes using the *Schemes endpoint (/users/schemes.{format}). The value has to be in EAS code list
https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/

party_identification

string | null

Seller/Buyer identifier

ID: BT-29 if Contact is a Seller
ID: BT-46 if Contact is a Buyer

bank_account

string

length ≤ 24

deprecated

Bank account number
Use the bank_account_number field instead.

bank_account_number

string

length ≤ 24

Contact's bank account number (do not specify if IBAN + BIC is used)

iban

string | null

Contact's IBAN (International Bank Account Number)

bic

string | null

Contact's BIC (Bank Identifier Code)

bank_account_id

integer | null

Internal Bank Account ID used to link the bank account configured for your account, where the contact deposits payments to you.

payment_method

integer | null

Payment method

1 - Cash
2 - Direct debit
3 - Hold
4 - Bank transfer
7 - Awarded contract
10 - Promissory note
11 - Cheque
12 - Reposition
13 - Other
14 - Compensation
15 - Payment by postgiro
17 - Bank cheque
19 - Bank card
54 - Credit card
56 - Bank giro
58 - SEPA bank transfer (SCT)
59 - SEPA Direct Debit (SDD)
101 - GIRO
102 - PayNow Corporate

1 2 3 4 7 10 11 12 13 14 15 17 19 54 56 58 59 101 102

payment_method_text

string | null

Payment method. The means, expressed as text, for how a payment is expected to be or has been settled.

terms

string | null

Defaults to custom

Term

custom - Custom
0 - Upon Receipt
15 - 15 days
30 - 30 days
60 - 60 days
90 - 90 days
120 - 120 days
0m-1 - Last day this month
1m-1 - Last day next month
1m1 - 1st day next month
2m1 - 1st day in two months
1m15 - 15th day next month
1m20 - 20th day next month
1m10 - 10th day next month

custom 0 15 30 60 90 120 0m-1 1m-1 1m1 2m1 1m15 1m20 1m10

sepa_type

string | null

SEPA payments type

company_identifier

string | null

contact_person

string

length ≤ 200

Contact person

edi_code

string | null

EDI Code

recipient_code

string

length ≤ 7

The recipient code is a 7-digit alphanumeric code that represents the telematic address of the electronic invoice receiver and is assigned by the SDI (Interchange System).

integration_code

string | null

Internal code of the client in the ERP.
It is used by B2Brouter in the integration process to assign the document to this customer

routing_codes

object

Routing codes

created_at

date-time

Date and time when the client record was created

updated_at

date-time

Date and time when the client record was last updated

404

Client not found

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app-staging.b2brouter.net/clients/id.json \
3
     --header 'accept: application/json'

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

application/json

application/xml

200Returns a client