BillBjorn API (1.0.0)

Download OpenAPI specification:Download

BillBjorn Support Team: support@billbjorn.com URL: https://developer.billbjorn.com

Documents

Document Exported Webhook

Document Exported Webhook. Event name 'document.exported'

Request Body schema: application/json

The document that has been exported

messageId required	string Unique message identifier
name required	string (WebhookName) Value: "document.exported" Webhook name. "noun.verb" format e.g. document.exported
required	object (Document)

Responses

Request samples

Payload

Content type

application/json

{"messageId": "1234",
"name": "document.exported",
"document": {"id": "1234",
"documentType": "PurchaseBill",
"contact": {"id": "1234",
"name": "Name",
"code": "56789"
},
"date": "2022-08-14",
"dueDate": "2022-08-28",
"documentNumber": "INV-1234",
"attachmentFileUrl": "https://firebasestorage.googleapis.com/1234/invoice.pdf",
"attachmentFileName": "invoice.pdf",
"paid": true,
"paidFromAccount": {"id": "1234",
"name": "Name",
"code": "56789"
},
"paidDate": "2022-08-20",
"paidReference": "xyz",
"taxType": "TaxInclusive",
"currency": "USD",
"status": "S5_Confirmed",
"externalDocumentId": "5678",
"lines": [{"description": "Description",
"account": {"id": "1234",
"name": "Name",
"code": "56789"
},
"taxRate": {"id": "1234",
"name": "Name",
"code": "56789"
},
"amount": 10.05
}
],
"yearAndMonth": "2022-08",
"taxTotal": 10.05,
"total": 100.5
}
}

Returns a Document List

Returns a list of documents

Authorizations:

OAuth2

query Parameters

page	integer [ 1 .. 100 ] Example: page=1 Page number. Default is 1.
limit	integer [ 1 .. 100 ] Example: limit=20 Paging limit. Default is 20. Up to 100 documents can be returned in a single API call
documentType	string or null (DocumentType) Enum: "None" "PurchaseBill" "SalesInvoice" "PurchaseReceipt" "SalesReceipt" "PurchaseCreditNote" "SalesCreditNote" "PurchaseCreditReceipt" "SalesCreditReceipt" Example: documentType=PurchaseBill Filter by document type
contactId	string Example: contactId=1234 Filter by contact id
status	string or null (DocumentStatus) Enum: "S0_New" "S1_Processing" "S2_ProcessingFinished" "S3_PendingReview" "S4_UploadPending" "S5_Confirmed" "S6_Error" "S7_Trash" Example: status=S5_Confirmed Filter by document status
minDate	string <date> Example: minDate=2022-08-01 Filter by minimum document date (inclusive)
maxDate	string <date> Example: maxDate=2022-08-31 Filter by maximum document date (inclusive)

Responses

Response samples

200
400

Content type

application/json

[{"id": "1234",
"documentType": "PurchaseBill",
"contact": {"id": "1234",
"name": "Name",
"code": "56789"
},
"date": "2022-08-14",
"dueDate": "2022-08-28",
"documentNumber": "INV-1234",
"attachmentFileUrl": "https://firebasestorage.googleapis.com/1234/invoice.pdf",
"attachmentFileName": "invoice.pdf",
"paid": true,
"paidFromAccount": {"id": "1234",
"name": "Name",
"code": "56789"
},
"paidDate": "2022-08-20",
"paidReference": "xyz",
"taxType": "TaxInclusive",
"currency": "USD",
"status": "S5_Confirmed",
"externalDocumentId": "5678",
"lines": [{"description": "Description",
"account": {"id": "1234",
"name": "Name",
"code": "56789"
},
"taxRate": {"id": "1234",
"name": "Name",
"code": "56789"
},
"amount": 10.05
}
],
"yearAndMonth": "2022-08",
"taxTotal": 10.05,
"total": 100.5
}
]

Files

Uploads a File

Uploads a file into the inbox

Authorizations:

OAuth2

Request Body schema: multipart/form-data

body required	string or null <byte> File contents
name required	string or null Name of the file you are uploading
filename	string or null
mimeType	string or null

Responses

Response samples

201
400

Content type

application/json

{"documentId": "1234"
}

Company

Returns a Company

Returns the name of the connected company.

Authorizations:

OAuth2

Responses

Response samples

200
400

Content type

application/json

{"id": "1234",
"name": "Demo Company"
}

Webhooks

Creates a Webhook

Creates a webhook

Authorizations:

OAuth2

Request Body schema: application/json

id	string Unique identifier
name required	string (WebhookName) Value: "document.exported" Webhook name. "noun.verb" format e.g. document.exported
url required	string Webhook callback URL
disabled	boolean Our API might set disabled to true if the webhook call fails repeatedly over a period of time

Responses

Request samples

Payload

Content type

application/json

{"id": "1234",
"name": "document.exported",
"url": "https://my.app.com/webhook",
"disabled": false
}

Response samples

201
400

Content type

application/json

{"id": "1234",
"name": "document.exported",
"url": "https://my.app.com/webhook",
"disabled": false
}

Returns a Webhook

Returns a webhook

Authorizations:

OAuth2

path Parameters

id

required

string

Example: 1234

Unique identifier for a webhook

Responses

Response samples

200
400

Content type

application/json

{"id": "1234",
"name": "document.exported",
"url": "https://my.app.com/webhook",
"disabled": false
}

Updates a Webhook

Updates a webhook

Authorizations:

OAuth2

path Parameters

id

required

string

Example: 1234

Unique identifier for a webhook

Request Body schema: application/json

id	string Unique identifier
name required	string (WebhookName) Value: "document.exported" Webhook name. "noun.verb" format e.g. document.exported
url required	string Webhook callback URL
disabled	boolean Our API might set disabled to true if the webhook call fails repeatedly over a period of time

Responses

Request samples

Payload

Content type

application/json

{"id": "1234",
"name": "document.exported",
"url": "https://my.app.com/webhook",
"disabled": false
}

Response samples

200
400

Content type

application/json

{"id": "1234",
"name": "document.exported",
"url": "https://my.app.com/webhook",
"disabled": false
}

Deletes a Webhook

Deletes a webhook

Authorizations:

OAuth2

path Parameters

id

required

string

Example: 1234

Unique identifier for a webhook

Responses

Response samples

400

Content type

application/json

{"status": "error",
"statusCode": 400,
"message": "Error description"
}