AMCS Group SupplierBill API
The SupplierBill API from AMCS Group — 3 operation(s) for supplierbill.
OpenAPI Specification
openapi: 3.0.1
info:
title: Core AccessGroup SupplierBill API
version: core
tags:
- name: SupplierBill
paths:
/purchasing/supplierBills/changes:
get:
tags:
- SupplierBill
summary: Retrieve changes
description: "| Property | Description|\r\n| -------------------- | -------------------------------------------------------------------------- |\r\n| RelatedSupplierGuid | The GUID associated to the supplier of the supplier bill.|\r\n| RelatedSupplierSiteGuid | The GUID associated to the supplier site of the supplier bill.|\r\n| Reference | The reference associated to the supplier bill.|\r\n| Description | The description associated to the supplier bill.|\r\n| Amount | The amount associated to the supplier bill.|\r\n| AmountExVat | The amount excluding VAT associated to the supplier bill.|\r\n| IsFinalised | Is this supplier bill finalised?|\r\n| IsMatched | Is this supplier bill matched?|\r\n| Date | The date associated to the supplier bill in ISO format (YYYY-MM-DD).|\r\n| DueDate | The due date associated to the supplier bill in ISO format (YYYY-MM-DD).|\r\n| Number | The number associated to the supplier bill. |\r\n| BillNo | The bill number associated to the supplier bill. |\r\n| RelatedGeneralLedgerExportGuid | The GUID of general ledger export associated to the supplier bill |"
operationId: SupplierBill_GetChanges
parameters:
- name: since
in: query
schema:
type: string
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceChanges[ApiIntegratorSupplierBillResource]'
/purchasing/supplierBills/{guid}:
get:
tags:
- SupplierBill
summary: Find with GUID
description: "| Property | Description|\r\n| -------------------- | -------------------------------------------------------------------------- |\r\n| RelatedSupplierGuid | The GUID associated to the supplier of the supplier bill.|\r\n| RelatedSupplierSiteGuid | The GUID associated to the supplier site of the supplier bill.|\r\n| Reference | The reference associated to the supplier bill.|\r\n| Description | The description associated to the supplier bill.|\r\n| Amount | The amount associated to the supplier bill.|\r\n| AmountExVat | The amount excluding VAT associated to the supplier bill.|\r\n| IsFinalised | Is this supplier bill finalised?|\r\n| IsMatched | Is this supplier bill matched?|\r\n| Date | The date associated to the supplier bill in ISO format (YYYY-MM-DD).|\r\n| DueDate | The due date associated to the supplier bill in ISO format (YYYY-MM-DD).|\r\n| Number | The number associated to the supplier bill. |\r\n| BillNo | The bill number associated to the supplier bill. |\r\n| RelatedGeneralLedgerExportGuid | The GUID of general ledger export associated to the supplier bill |"
operationId: SupplierBill_Get
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity[ApiIntegratorSupplierBillResource]'
put:
tags:
- SupplierBill
summary: Partial update
description: "| Property | Description | Required |\r\n| -------------------- | --------------------------------------------------------------------- | -------- |\r\n| RelatedSupplierGuid | The GUID associated to the supplier of the supplier bill. | Yes |\r\n| RelatedSupplierSiteGuid | The GUID associated to the supplier site of the supplier bill.| No |\r\n| Reference | The reference associated to the supplier bill.| No |\r\n| Description | The description associated to the supplier bill.| Yes |\r\n| Amount | The amount associated to the supplier bill.| Yes |\r\n| AmountExVat | The amount excluding VAT associated to the supplier bill.| Yes |\r\n| IsFinalised | Is this supplier bill finalised? | Yes |\r\n| IsMatched | Is this supplier bill matched?| Yes |\r\n| Date | The date associated to the supplier bill in ISO format (YYYY-MM-DD).| Yes |\r\n| DueDate | The due date associated to the supplier bill in ISO format (YYYY-MM-DD).| Yes |\r\n| Number | The number associated to the supplier bill | Yes |\r\n| BillNo | The bill number associated to the supplier bill. | No |\r\n\r\n**Extra validations**\r\n\r\n| Condition | Error message |\r\n| --------- | ------------- |\r\n| IsFinalised is true | Can only create applied costs if bill is not finalised |\r\n| SupplierSite not found with value RelatedSupplierSiteGuid | Failed to retrieve SupplierSite with RelatedSupplierSiteGuid of {value of RelatedSupplierSiteGuid} |\r\n| Supplier not found with value RelatedSupplierGuid | Failed to retrieve Supplier with RelatedSupplierGuid of {value of RelatedSupplierGuid} |\r\n| Description is more than 60 characters long | Description must be no more than 60 characters long. |\r\n| Number is more than 60 characters long | Number must be no more than 60 characters long. |\r\n| Number already exists for the current supplier | The bill number must be unique per supplier | \r\n| IsMatched is true | Can only create applied costs if bill is unmatched |\r\n| IsFinalised is true | Can only create applied costs if bill is not finalised |\r\n| IsProForma is true | IsProForma must be false |\r\n| BillNo is not null | BillNo is a read-only property. |"
operationId: SupplierBill_Update
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorSupplierBillResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/purchasing/supplierBills:
get:
tags:
- SupplierBill
summary: Find with Filters
description: "| Property | Description|\r\n| -------------------- | -------------------------------------------------------------------------- |\r\n| RelatedSupplierGuid | The GUID associated to the supplier of the supplier bill.|\r\n| RelatedSupplierSiteGuid | The GUID associated to the supplier site of the supplier bill.|\r\n| Reference | The reference associated to the supplier bill.|\r\n| Description | The description associated to the supplier bill.|\r\n| Amount | The amount associated to the supplier bill.|\r\n| AmountExVat | The amount excluding VAT associated to the supplier bill.|\r\n| IsFinalised | Is this supplier bill finalised?|\r\n| IsMatched | Is this supplier bill matched?|\r\n| Date | The date associated to the supplier bill in ISO format (YYYY-MM-DD).|\r\n| DueDate | The due date associated to the supplier bill in ISO format (YYYY-MM-DD).|\r\n| Number | The number associated to the supplier bill. |\r\n| BillNo | The bill number associated to the supplier bill. |\r\n| RelatedGeneralLedgerExportGuid | The GUID of general ledger export associated to the supplier bill |"
operationId: SupplierBill_GetCollection
parameters:
- name: filter
in: query
schema:
type: string
- name: max
in: query
schema:
type: integer
format: int32
- name: page
in: query
schema:
type: integer
format: int32
- name: includeCount
in: query
schema:
type: boolean
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultCollection[ApiIntegratorSupplierBillResource]'
post:
tags:
- SupplierBill
summary: Create or update
description: "| Property | Description | Required |\r\n| -------------------- | --------------------------------------------------------------------- | -------- |\r\n| RelatedSupplierGuid | The GUID associated to the supplier of the supplier bill. | Yes |\r\n| RelatedSupplierSiteGuid | The GUID associated to the supplier site of the supplier bill.| No |\r\n| Reference | The reference associated to the supplier bill.| No |\r\n| Description | The description associated to the supplier bill.| Yes |\r\n| Amount | The amount associated to the supplier bill.| Yes |\r\n| AmountExVat | The amount excluding VAT associated to the supplier bill.| Yes |\r\n| IsFinalised | Is this supplier bill finalised? | Yes |\r\n| IsMatched | Is this supplier bill matched?| Yes |\r\n| Date | The date associated to the supplier bill in ISO format (YYYY-MM-DD).| Yes |\r\n| DueDate | The due date associated to the supplier bill in ISO format (YYYY-MM-DD).| Yes |\r\n| Number | The number associated to the supplier bill | Yes |\r\n| BillNo | The bill number associated to the supplier bill. | No |\r\n\r\n**Extra validations**\r\n\r\n| Condition | Error message |\r\n| --------- | ------------- |\r\n| IsFinalised is true | Can only create applied costs if bill is not finalised |\r\n| SupplierSite not found with value RelatedSupplierSiteGuid | Failed to retrieve SupplierSite with RelatedSupplierSiteGuid of {value of RelatedSupplierSiteGuid} |\r\n| Supplier not found with value RelatedSupplierGuid | Failed to retrieve Supplier with RelatedSupplierGuid of {value of RelatedSupplierGuid} |\r\n| Description is more than 60 characters long | Description must be no more than 60 characters long. |\r\n| Number is more than 60 characters long | Number must be no more than 60 characters long. |\r\n| Number already exists for the current supplier | The bill number must be unique per supplier | \r\n| IsMatched is true | Can only create applied costs if bill is unmatched |\r\n| IsFinalised is true | Can only create applied costs if bill is not finalised |\r\n| IsProForma is true | IsProForma must be false |\r\n| BillNo is not null | BillNo is a read-only property. |"
operationId: SupplierBill_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorSupplierBillResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
components:
schemas:
ApiResourceChanges[ApiIntegratorSupplierBillResource]:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorSupplierBillResource'
extra:
$ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultUpdatesExtra:
type: object
properties:
until:
type: string
cursor:
type: string
ApiResourceResultEntity[ApiIntegratorSupplierBillResource]:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorSupplierBillResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceId:
type: object
properties:
resource:
type: string
format: uuid
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultCollection[ApiIntegratorSupplierBillResource]:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorSupplierBillResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceErrors:
type: object
properties:
errors:
type: string
ApiIntegratorSupplierBillResource:
type: object
properties:
RelatedSupplierGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedSupplierSiteGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
Reference:
type: string
Description:
type: string
Amount:
type: number
format: double
AmountExVat:
type: number
format: double
IsFinalised:
type: boolean
IsMatched:
type: boolean
RelatedGeneralLedgerExportGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
Date:
type: string
format: localDate
example: '2000-01-01'
DueDate:
type: string
format: localDate
example: '2000-01-01'
Number:
type: string
BillNo:
type: integer
format: int32
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
ApiResourceResultEntityExtra:
type: object
properties:
expand:
type: object
additionalProperties:
type: object
additionalProperties:
type: object
include:
type: object
additionalProperties:
type: array
items:
type: object
additionalProperties:
type: object
ApiResourceResultEntityLinks:
type: object
properties:
self:
type: string
associations:
type: array
items:
type: string
expand:
type: array
items:
type: string
operations:
type: array
items:
type: string
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean