Skip to content

katana_public_api_client.api.purchase_order.receive_purchase_order

katana_public_api_client.api.purchase_order.receive_purchase_order

Classes

Functions

asyncio(*, client, body) async

Receive a purchase order

If you receive the items on the purchase order, you can mark the purchase order as received. This will update the existing purchase order rows quantities to the quantities left unreceived and create a new rows with the received quantities and dates. If you want to mark all rows as received and the order doesn't contain batch tracked items, you can use PATCH /purchase_orders/id endpoint. Reverting the receive must also be done through that endpoint.

Each call records one receipt group: all rows received in the call share one group_id, whatever their received_date. A partial quantity splits the row; the received part becomes a new row and the original row keeps the open remainder. Reverting the order (PATCH /purchase_orders/{id} with status NOT_RECEIVED) undoes all receipt groups at once; a single group cannot be reverted.

Parameters:

  • body (list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow) –

    Request payload for recording the receipt of purchase order items at the facility Example: [{'purchase_order_row_id': 501, 'quantity': 150, 'received_date': '2024-02-15T10:00:00Z'}, {'purchase_order_row_id': 502, 'quantity': 75, 'received_date': '2024-02-15T10:00:00Z'}].

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/purchase_order/receive_purchase_order.py 
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
    body: list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow,
) -> Any | DetailedErrorResponse | ErrorResponse | None:
    """Receive a purchase order

     If you receive the items on the purchase order, you can mark the purchase order as received.
        This will update the existing purchase order rows quantities to the quantities left unreceived
    and
        create a new rows with the received quantities and dates. If you want to mark all rows as
    received and
        the order doesn't contain batch tracked items, you can use PATCH /purchase_orders/id endpoint.
        Reverting the receive must also be done through that endpoint.

    Each call records one receipt group: all rows received in the call share one `group_id`, whatever
    their `received_date`. A partial quantity splits the row; the received part becomes a new row and
    the
    original row keeps the open remainder. Reverting the order
    (PATCH /purchase_orders/{id} with status NOT_RECEIVED) undoes all receipt groups at once; a single
    group cannot be reverted.

    Args:
        body (list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow): Request payload for
            recording the receipt of purchase order items at the facility Example:
            [{'purchase_order_row_id': 501, 'quantity': 150, 'received_date': '2024-02-15T10:00:00Z'},
            {'purchase_order_row_id': 502, 'quantity': 75, 'received_date': '2024-02-15T10:00:00Z'}].

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Any | DetailedErrorResponse | ErrorResponse
    """

    return (
        await asyncio_detailed(
            client=client,
            body=body,
        )
    ).parsed

asyncio_detailed(*, client, body) async

Receive a purchase order

If you receive the items on the purchase order, you can mark the purchase order as received. This will update the existing purchase order rows quantities to the quantities left unreceived and create a new rows with the received quantities and dates. If you want to mark all rows as received and the order doesn't contain batch tracked items, you can use PATCH /purchase_orders/id endpoint. Reverting the receive must also be done through that endpoint.

Each call records one receipt group: all rows received in the call share one group_id, whatever their received_date. A partial quantity splits the row; the received part becomes a new row and the original row keeps the open remainder. Reverting the order (PATCH /purchase_orders/{id} with status NOT_RECEIVED) undoes all receipt groups at once; a single group cannot be reverted.

Parameters:

  • body (list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow) –

    Request payload for recording the receipt of purchase order items at the facility Example: [{'purchase_order_row_id': 501, 'quantity': 150, 'received_date': '2024-02-15T10:00:00Z'}, {'purchase_order_row_id': 502, 'quantity': 75, 'received_date': '2024-02-15T10:00:00Z'}].

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/purchase_order/receive_purchase_order.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow,
) -> Response[Any | DetailedErrorResponse | ErrorResponse]:
    """Receive a purchase order

     If you receive the items on the purchase order, you can mark the purchase order as received.
        This will update the existing purchase order rows quantities to the quantities left unreceived
    and
        create a new rows with the received quantities and dates. If you want to mark all rows as
    received and
        the order doesn't contain batch tracked items, you can use PATCH /purchase_orders/id endpoint.
        Reverting the receive must also be done through that endpoint.

    Each call records one receipt group: all rows received in the call share one `group_id`, whatever
    their `received_date`. A partial quantity splits the row; the received part becomes a new row and
    the
    original row keeps the open remainder. Reverting the order
    (PATCH /purchase_orders/{id} with status NOT_RECEIVED) undoes all receipt groups at once; a single
    group cannot be reverted.

    Args:
        body (list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow): Request payload for
            recording the receipt of purchase order items at the facility Example:
            [{'purchase_order_row_id': 501, 'quantity': 150, 'received_date': '2024-02-15T10:00:00Z'},
            {'purchase_order_row_id': 502, 'quantity': 75, 'received_date': '2024-02-15T10:00:00Z'}].

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Response[Any | DetailedErrorResponse | ErrorResponse]
    """

    kwargs = _get_kwargs(
        body=body,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync(*, client, body)

Receive a purchase order

If you receive the items on the purchase order, you can mark the purchase order as received. This will update the existing purchase order rows quantities to the quantities left unreceived and create a new rows with the received quantities and dates. If you want to mark all rows as received and the order doesn't contain batch tracked items, you can use PATCH /purchase_orders/id endpoint. Reverting the receive must also be done through that endpoint.

Each call records one receipt group: all rows received in the call share one group_id, whatever their received_date. A partial quantity splits the row; the received part becomes a new row and the original row keeps the open remainder. Reverting the order (PATCH /purchase_orders/{id} with status NOT_RECEIVED) undoes all receipt groups at once; a single group cannot be reverted.

Parameters:

  • body (list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow) –

    Request payload for recording the receipt of purchase order items at the facility Example: [{'purchase_order_row_id': 501, 'quantity': 150, 'received_date': '2024-02-15T10:00:00Z'}, {'purchase_order_row_id': 502, 'quantity': 75, 'received_date': '2024-02-15T10:00:00Z'}].

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/purchase_order/receive_purchase_order.py 
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
def sync(
    *,
    client: AuthenticatedClient | Client,
    body: list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow,
) -> Any | DetailedErrorResponse | ErrorResponse | None:
    """Receive a purchase order

     If you receive the items on the purchase order, you can mark the purchase order as received.
        This will update the existing purchase order rows quantities to the quantities left unreceived
    and
        create a new rows with the received quantities and dates. If you want to mark all rows as
    received and
        the order doesn't contain batch tracked items, you can use PATCH /purchase_orders/id endpoint.
        Reverting the receive must also be done through that endpoint.

    Each call records one receipt group: all rows received in the call share one `group_id`, whatever
    their `received_date`. A partial quantity splits the row; the received part becomes a new row and
    the
    original row keeps the open remainder. Reverting the order
    (PATCH /purchase_orders/{id} with status NOT_RECEIVED) undoes all receipt groups at once; a single
    group cannot be reverted.

    Args:
        body (list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow): Request payload for
            recording the receipt of purchase order items at the facility Example:
            [{'purchase_order_row_id': 501, 'quantity': 150, 'received_date': '2024-02-15T10:00:00Z'},
            {'purchase_order_row_id': 502, 'quantity': 75, 'received_date': '2024-02-15T10:00:00Z'}].

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Any | DetailedErrorResponse | ErrorResponse
    """

    return sync_detailed(
        client=client,
        body=body,
    ).parsed

sync_detailed(*, client, body)

Receive a purchase order

If you receive the items on the purchase order, you can mark the purchase order as received. This will update the existing purchase order rows quantities to the quantities left unreceived and create a new rows with the received quantities and dates. If you want to mark all rows as received and the order doesn't contain batch tracked items, you can use PATCH /purchase_orders/id endpoint. Reverting the receive must also be done through that endpoint.

Each call records one receipt group: all rows received in the call share one group_id, whatever their received_date. A partial quantity splits the row; the received part becomes a new row and the original row keeps the open remainder. Reverting the order (PATCH /purchase_orders/{id} with status NOT_RECEIVED) undoes all receipt groups at once; a single group cannot be reverted.

Parameters:

  • body (list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow) –

    Request payload for recording the receipt of purchase order items at the facility Example: [{'purchase_order_row_id': 501, 'quantity': 150, 'received_date': '2024-02-15T10:00:00Z'}, {'purchase_order_row_id': 502, 'quantity': 75, 'received_date': '2024-02-15T10:00:00Z'}].

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/purchase_order/receive_purchase_order.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow,
) -> Response[Any | DetailedErrorResponse | ErrorResponse]:
    """Receive a purchase order

     If you receive the items on the purchase order, you can mark the purchase order as received.
        This will update the existing purchase order rows quantities to the quantities left unreceived
    and
        create a new rows with the received quantities and dates. If you want to mark all rows as
    received and
        the order doesn't contain batch tracked items, you can use PATCH /purchase_orders/id endpoint.
        Reverting the receive must also be done through that endpoint.

    Each call records one receipt group: all rows received in the call share one `group_id`, whatever
    their `received_date`. A partial quantity splits the row; the received part becomes a new row and
    the
    original row keeps the open remainder. Reverting the order
    (PATCH /purchase_orders/{id} with status NOT_RECEIVED) undoes all receipt groups at once; a single
    group cannot be reverted.

    Args:
        body (list[PurchaseOrderReceiveRow] | PurchaseOrderReceiveRow): Request payload for
            recording the receipt of purchase order items at the facility Example:
            [{'purchase_order_row_id': 501, 'quantity': 150, 'received_date': '2024-02-15T10:00:00Z'},
            {'purchase_order_row_id': 502, 'quantity': 75, 'received_date': '2024-02-15T10:00:00Z'}].

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Response[Any | DetailedErrorResponse | ErrorResponse]
    """

    kwargs = _get_kwargs(
        body=body,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)