BokaMera.API.Host

<back to all web services

AddBillingInformation

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/billing/company/Add new billing information.Add new billing information.
AddBillingInformation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
NamebodystringYesThe name that should be printed on the billing information, normally this would be your company name.
AttentionbodystringYesIf you want to add the attention to the billing person.
Street1bodystringYesThe street for the billing adress. This is required when having postal invoice as billing method.
Street2bodystringYesThe street for the billing adress.
ZipCodebodystringYesThe zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
CitybodystringYesThe city for the billing adress. This is required when having postal invoice as billing method.
EmailbodystringYesThe billing email. This is required when having email invoice as billing method.
PaymentTermsDaysbodyint?NoThe billing payment terms in days. This is default 15 days.
VatRegistrationNumberbodystringYesThe company vat registration number.
GLNbodystringYesThe company global location number.
ReferenceLine1bodystringYesYour internal reference.
ReferenceLine2bodystringYesYour internal reference.
BillingInfoBase Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYes
LastNameformstringYes
PhoneNumberformstringYes
CountryIdformstringYes
BillingMethodIdformintNo
BillingInformationResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id.
BillingMethodIdformintYesThe prefered billing method.
NameformstringYesThe name that should be printed on the billing information, normally this would be your company name.
FirstNameformstringYesBilling person first name
LastNameformstringYesBilling person last name
PhoneNumberformstringYesBilling person phone numbers
AttentionformstringYesIf you want to add the attention to the billing address.
Street1formstringYesThe street for the billing adress. This is required when having postal invoice as billing method.
Street2formstringYesThe street for the billing adress.
ZipCodeformstringYesThe zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
CityformstringYesThe city for the billing adress. This is required when having postal invoice as billing method.
CountryIdformstringYesThe country for the billing adress. This is required when having postal invoice as billing method.
EmailformstringYesThe billing email. This is required when having email invoice as billing method.
GLNformstringYesThe company global location number.
ReferenceLine1formstringYesYour internal reference.
ReferenceLine2formstringYesYour internal reference.
PaymentTermsDaysformintNoThe billing payment terms in days. This is default 15 days.
VatRegistrationNumberformstringYesThe company vat registration number.
BillingMethodOptionsformList<BillingMethod>YesThe billing method options to choose from
BillingMethod Parameters:
NameParameterData TypeRequiredDescription
BillingMethodCountriesRelationformList<BillingMethodCountriesRelation>Yes
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
BillingMethodCountriesRelation Parameters:
NameParameterData TypeRequiredDescription
BillingMethodIdformintYes
CountryIdformstringYes
ModifiedDateformDateTimeOffset?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /billing/company/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Name":"String","Attention":"String","Street1":"String","Street2":"String","ZipCode":"String","City":"String","Email":"String","PaymentTermsDays":0,"VatRegistrationNumber":"String","GLN":"String","ReferenceLine1":"String","ReferenceLine2":"String","FirstName":"String","LastName":"String","PhoneNumber":"String","CountryId":"String","BillingMethodId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"BillingMethodId":0,"Name":"String","FirstName":"String","LastName":"String","PhoneNumber":"String","Attention":"String","Street1":"String","Street2":"String","ZipCode":"String","City":"String","CountryId":"String","Email":"String","GLN":"String","ReferenceLine1":"String","ReferenceLine2":"String","PaymentTermsDays":0,"VatRegistrationNumber":"String","BillingMethodOptions":[{"BillingMethodCountriesRelation":[{"BillingMethodId":0,"CountryId":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00"}],"Name":"String","Description":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":0}]}